diff --git a/latest/404.html b/latest/404.html index c0b7b11030..dc3a886be8 100644 --- a/latest/404.html +++ b/latest/404.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../v5.2.5/404.html... + Redirecting to ../v5.2.6/404.html... \ No newline at end of file diff --git a/latest/custom_theme/main.html b/latest/custom_theme/main.html index 59a8dd8ab9..1d15302382 100644 --- a/latest/custom_theme/main.html +++ b/latest/custom_theme/main.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../v5.2.5/custom_theme/main.html... + Redirecting to ../../v5.2.6/custom_theme/main.html... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.catalogcategory/index.html b/latest/extensions/api/classes/common.catalog.catalogcategory/index.html index 7ff60137c7..57d257b764 100644 --- a/latest/extensions/api/classes/common.catalog.catalogcategory/index.html +++ b/latest/extensions/api/classes/common.catalog.catalogcategory/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.catalogcategory/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.catalogcategory/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.catalogentity/index.html b/latest/extensions/api/classes/common.catalog.catalogentity/index.html index 53ad4b16e0..3944c9f1fc 100644 --- a/latest/extensions/api/classes/common.catalog.catalogentity/index.html +++ b/latest/extensions/api/classes/common.catalog.catalogentity/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.catalogentity/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.catalogentity/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.generalcategory/index.html b/latest/extensions/api/classes/common.catalog.generalcategory/index.html index 1249969dda..584df2f2e4 100644 --- a/latest/extensions/api/classes/common.catalog.generalcategory/index.html +++ b/latest/extensions/api/classes/common.catalog.generalcategory/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.generalcategory/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.generalcategory/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.generalentity/index.html b/latest/extensions/api/classes/common.catalog.generalentity/index.html index d6793aae0f..6ab0036e44 100644 --- a/latest/extensions/api/classes/common.catalog.generalentity/index.html +++ b/latest/extensions/api/classes/common.catalog.generalentity/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.generalentity/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.generalentity/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.kubernetescluster/index.html b/latest/extensions/api/classes/common.catalog.kubernetescluster/index.html index f0b798f377..c0e6784924 100644 --- a/latest/extensions/api/classes/common.catalog.kubernetescluster/index.html +++ b/latest/extensions/api/classes/common.catalog.kubernetescluster/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.kubernetescluster/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.kubernetescluster/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.weblink/index.html b/latest/extensions/api/classes/common.catalog.weblink/index.html index feeb064f65..5479885403 100644 --- a/latest/extensions/api/classes/common.catalog.weblink/index.html +++ b/latest/extensions/api/classes/common.catalog.weblink/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.weblink/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.weblink/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.catalog.weblinkcategory/index.html b/latest/extensions/api/classes/common.catalog.weblinkcategory/index.html index 3a793e92e4..51c1f7e6a3 100644 --- a/latest/extensions/api/classes/common.catalog.weblinkcategory/index.html +++ b/latest/extensions/api/classes/common.catalog.weblinkcategory/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.catalog.weblinkcategory/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.catalog.weblinkcategory/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.store.extensionstore/index.html b/latest/extensions/api/classes/common.store.extensionstore/index.html index 32d28566f2..c515e9b17d 100644 --- a/latest/extensions/api/classes/common.store.extensionstore/index.html +++ b/latest/extensions/api/classes/common.store.extensionstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.store.extensionstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.store.extensionstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/common.util.singleton/index.html b/latest/extensions/api/classes/common.util.singleton/index.html index f13ce80c42..607bccbc18 100644 --- a/latest/extensions/api/classes/common.util.singleton/index.html +++ b/latest/extensions/api/classes/common.util.singleton/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/common.util.singleton/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/common.util.singleton/... \ No newline at end of file diff --git a/latest/extensions/api/classes/main.catalog.catalogentityregistry/index.html b/latest/extensions/api/classes/main.catalog.catalogentityregistry/index.html index ea727a4469..87675a0e50 100644 --- a/latest/extensions/api/classes/main.catalog.catalogentityregistry/index.html +++ b/latest/extensions/api/classes/main.catalog.catalogentityregistry/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/main.catalog.catalogentityregistry/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/main.catalog.catalogentityregistry/... \ No newline at end of file diff --git a/latest/extensions/api/classes/main.ipc/index.html b/latest/extensions/api/classes/main.ipc/index.html index d51d8c961c..4c4af7ee75 100644 --- a/latest/extensions/api/classes/main.ipc/index.html +++ b/latest/extensions/api/classes/main.ipc/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/main.ipc/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/main.ipc/... \ No newline at end of file diff --git a/latest/extensions/api/classes/main.lensextension/index.html b/latest/extensions/api/classes/main.lensextension/index.html index 26325d45ac..fef342417e 100644 --- a/latest/extensions/api/classes/main.lensextension/index.html +++ b/latest/extensions/api/classes/main.lensextension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/main.lensextension/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/main.lensextension/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html b/latest/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html index 4e05445496..fea4a421eb 100644 --- a/latest/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html +++ b/latest/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.catalog.catalogentityregistry/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.catalog.catalogentityregistry/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.badge/index.html b/latest/extensions/api/classes/renderer.component.badge/index.html index fe3566f5a9..4092bf262f 100644 --- a/latest/extensions/api/classes/renderer.component.badge/index.html +++ b/latest/extensions/api/classes/renderer.component.badge/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.badge/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.badge/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.barchart/index.html b/latest/extensions/api/classes/renderer.component.barchart/index.html index 53b8ac5bde..fdabd1e9bc 100644 --- a/latest/extensions/api/classes/renderer.component.barchart/index.html +++ b/latest/extensions/api/classes/renderer.component.barchart/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.barchart/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.barchart/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.button/index.html b/latest/extensions/api/classes/renderer.component.button/index.html index d5eeecff97..d33539ab8d 100644 --- a/latest/extensions/api/classes/renderer.component.button/index.html +++ b/latest/extensions/api/classes/renderer.component.button/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.button/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.button/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.checkbox/index.html b/latest/extensions/api/classes/renderer.component.checkbox/index.html index 4b84f94122..0c0a75cd0d 100644 --- a/latest/extensions/api/classes/renderer.component.checkbox/index.html +++ b/latest/extensions/api/classes/renderer.component.checkbox/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.checkbox/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.checkbox/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.commandoverlay/index.html b/latest/extensions/api/classes/renderer.component.commandoverlay/index.html index 3d6deacf6f..c8d8dff957 100644 --- a/latest/extensions/api/classes/renderer.component.commandoverlay/index.html +++ b/latest/extensions/api/classes/renderer.component.commandoverlay/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.commandoverlay/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.commandoverlay/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.confirmdialog/index.html b/latest/extensions/api/classes/renderer.component.confirmdialog/index.html index 28c392c51a..65e32247e1 100644 --- a/latest/extensions/api/classes/renderer.component.confirmdialog/index.html +++ b/latest/extensions/api/classes/renderer.component.confirmdialog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.confirmdialog/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.confirmdialog/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.dialog/index.html b/latest/extensions/api/classes/renderer.component.dialog/index.html index e63989721b..cf4aa3822c 100644 --- a/latest/extensions/api/classes/renderer.component.dialog/index.html +++ b/latest/extensions/api/classes/renderer.component.dialog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.dialog/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.dialog/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.drawer/index.html b/latest/extensions/api/classes/renderer.component.drawer/index.html index 7d5914577e..e7b071f353 100644 --- a/latest/extensions/api/classes/renderer.component.drawer/index.html +++ b/latest/extensions/api/classes/renderer.component.drawer/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.drawer/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.drawer/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.draweritem/index.html b/latest/extensions/api/classes/renderer.component.draweritem/index.html index bf10f49b72..feb235df3b 100644 --- a/latest/extensions/api/classes/renderer.component.draweritem/index.html +++ b/latest/extensions/api/classes/renderer.component.draweritem/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.draweritem/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.draweritem/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.drawerparamtoggler/index.html b/latest/extensions/api/classes/renderer.component.drawerparamtoggler/index.html index 4b886dd20e..0c63eba3aa 100644 --- a/latest/extensions/api/classes/renderer.component.drawerparamtoggler/index.html +++ b/latest/extensions/api/classes/renderer.component.drawerparamtoggler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.drawerparamtoggler/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.drawerparamtoggler/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.drawertitle/index.html b/latest/extensions/api/classes/renderer.component.drawertitle/index.html index f41ed2fc2c..2c63f458d0 100644 --- a/latest/extensions/api/classes/renderer.component.drawertitle/index.html +++ b/latest/extensions/api/classes/renderer.component.drawertitle/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.drawertitle/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.drawertitle/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.icon/index.html b/latest/extensions/api/classes/renderer.component.icon/index.html index f94dd8231e..b0c46ea0d3 100644 --- a/latest/extensions/api/classes/renderer.component.icon/index.html +++ b/latest/extensions/api/classes/renderer.component.icon/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.icon/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.icon/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.input/index.html b/latest/extensions/api/classes/renderer.component.input/index.html index 30ccdff423..d12aec85a1 100644 --- a/latest/extensions/api/classes/renderer.component.input/index.html +++ b/latest/extensions/api/classes/renderer.component.input/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.input/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.input/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.kubeeventdetails/index.html b/latest/extensions/api/classes/renderer.component.kubeeventdetails/index.html index ebb357a97e..636305da60 100644 --- a/latest/extensions/api/classes/renderer.component.kubeeventdetails/index.html +++ b/latest/extensions/api/classes/renderer.component.kubeeventdetails/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.kubeeventdetails/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.kubeeventdetails/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.kubeobjectdetails/index.html b/latest/extensions/api/classes/renderer.component.kubeobjectdetails/index.html index a09c7f9f5b..d96b4a7062 100644 --- a/latest/extensions/api/classes/renderer.component.kubeobjectdetails/index.html +++ b/latest/extensions/api/classes/renderer.component.kubeobjectdetails/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.kubeobjectdetails/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.kubeobjectdetails/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html b/latest/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html index b86e85874b..bfb100124b 100644 --- a/latest/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html +++ b/latest/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.kubeobjectlistlayout/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.kubeobjectlistlayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.kubeobjectmenu/index.html b/latest/extensions/api/classes/renderer.component.kubeobjectmenu/index.html index b9204aab9b..d547b8eacd 100644 --- a/latest/extensions/api/classes/renderer.component.kubeobjectmenu/index.html +++ b/latest/extensions/api/classes/renderer.component.kubeobjectmenu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.kubeobjectmenu/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.kubeobjectmenu/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.kubeobjectmeta/index.html b/latest/extensions/api/classes/renderer.component.kubeobjectmeta/index.html index 54c6dac137..054acc7beb 100644 --- a/latest/extensions/api/classes/renderer.component.kubeobjectmeta/index.html +++ b/latest/extensions/api/classes/renderer.component.kubeobjectmeta/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.kubeobjectmeta/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.kubeobjectmeta/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.lineprogress/index.html b/latest/extensions/api/classes/renderer.component.lineprogress/index.html index afad538d53..82c73b9d70 100644 --- a/latest/extensions/api/classes/renderer.component.lineprogress/index.html +++ b/latest/extensions/api/classes/renderer.component.lineprogress/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.lineprogress/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.lineprogress/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.mainlayout/index.html b/latest/extensions/api/classes/renderer.component.mainlayout/index.html index 8c2623478a..b4bbb770df 100644 --- a/latest/extensions/api/classes/renderer.component.mainlayout/index.html +++ b/latest/extensions/api/classes/renderer.component.mainlayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.mainlayout/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.mainlayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.menu/index.html b/latest/extensions/api/classes/renderer.component.menu/index.html index 6b55e5715b..74f22b2c56 100644 --- a/latest/extensions/api/classes/renderer.component.menu/index.html +++ b/latest/extensions/api/classes/renderer.component.menu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.menu/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.menu/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.menuactions/index.html b/latest/extensions/api/classes/renderer.component.menuactions/index.html index 9d9234f1cf..23d56ad843 100644 --- a/latest/extensions/api/classes/renderer.component.menuactions/index.html +++ b/latest/extensions/api/classes/renderer.component.menuactions/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.menuactions/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.menuactions/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.menuitem/index.html b/latest/extensions/api/classes/renderer.component.menuitem/index.html index 3370930437..dfb5a3b70d 100644 --- a/latest/extensions/api/classes/renderer.component.menuitem/index.html +++ b/latest/extensions/api/classes/renderer.component.menuitem/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.menuitem/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.menuitem/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.namespaceselect/index.html b/latest/extensions/api/classes/renderer.component.namespaceselect/index.html index b743e898d7..169f8ddaba 100644 --- a/latest/extensions/api/classes/renderer.component.namespaceselect/index.html +++ b/latest/extensions/api/classes/renderer.component.namespaceselect/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.namespaceselect/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.namespaceselect/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.namespaceselectfilter/index.html b/latest/extensions/api/classes/renderer.component.namespaceselectfilter/index.html index c03b09648e..1cfd592ec3 100644 --- a/latest/extensions/api/classes/renderer.component.namespaceselectfilter/index.html +++ b/latest/extensions/api/classes/renderer.component.namespaceselectfilter/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.namespaceselectfilter/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.namespaceselectfilter/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.notifications/index.html b/latest/extensions/api/classes/renderer.component.notifications/index.html index f668ae8a4a..e2b7ee85e5 100644 --- a/latest/extensions/api/classes/renderer.component.notifications/index.html +++ b/latest/extensions/api/classes/renderer.component.notifications/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.notifications/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.notifications/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.notificationsstore/index.html b/latest/extensions/api/classes/renderer.component.notificationsstore/index.html index ba04a7fc6c..c423fe4211 100644 --- a/latest/extensions/api/classes/renderer.component.notificationsstore/index.html +++ b/latest/extensions/api/classes/renderer.component.notificationsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.notificationsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.notificationsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.pagelayout/index.html b/latest/extensions/api/classes/renderer.component.pagelayout/index.html index b94bf7f5e8..2fe1e31bf2 100644 --- a/latest/extensions/api/classes/renderer.component.pagelayout/index.html +++ b/latest/extensions/api/classes/renderer.component.pagelayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.pagelayout/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.pagelayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.piechart/index.html b/latest/extensions/api/classes/renderer.component.piechart/index.html index f8acb0a8f0..c1849cb493 100644 --- a/latest/extensions/api/classes/renderer.component.piechart/index.html +++ b/latest/extensions/api/classes/renderer.component.piechart/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.piechart/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.piechart/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.poddetailslist/index.html b/latest/extensions/api/classes/renderer.component.poddetailslist/index.html index 5c32271d4f..c35f4b6f66 100644 --- a/latest/extensions/api/classes/renderer.component.poddetailslist/index.html +++ b/latest/extensions/api/classes/renderer.component.poddetailslist/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.poddetailslist/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.poddetailslist/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.radio/index.html b/latest/extensions/api/classes/renderer.component.radio/index.html index 5502f5be62..3a97524c5b 100644 --- a/latest/extensions/api/classes/renderer.component.radio/index.html +++ b/latest/extensions/api/classes/renderer.component.radio/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.radio/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.radio/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.radiogroup/index.html b/latest/extensions/api/classes/renderer.component.radiogroup/index.html index e43a7c54f1..21bf325db5 100644 --- a/latest/extensions/api/classes/renderer.component.radiogroup/index.html +++ b/latest/extensions/api/classes/renderer.component.radiogroup/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.radiogroup/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.radiogroup/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.searchinput/index.html b/latest/extensions/api/classes/renderer.component.searchinput/index.html index f6d290fd3a..7723c11e5a 100644 --- a/latest/extensions/api/classes/renderer.component.searchinput/index.html +++ b/latest/extensions/api/classes/renderer.component.searchinput/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.searchinput/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.searchinput/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.select/index.html b/latest/extensions/api/classes/renderer.component.select/index.html index 73e0b1320f..40fb7122b1 100644 --- a/latest/extensions/api/classes/renderer.component.select/index.html +++ b/latest/extensions/api/classes/renderer.component.select/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.select/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.select/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.settinglayout/index.html b/latest/extensions/api/classes/renderer.component.settinglayout/index.html index e1613326db..591b4c2f31 100644 --- a/latest/extensions/api/classes/renderer.component.settinglayout/index.html +++ b/latest/extensions/api/classes/renderer.component.settinglayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.settinglayout/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.settinglayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.slider/index.html b/latest/extensions/api/classes/renderer.component.slider/index.html index 9815f73042..fc76f39336 100644 --- a/latest/extensions/api/classes/renderer.component.slider/index.html +++ b/latest/extensions/api/classes/renderer.component.slider/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.slider/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.slider/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.spinner/index.html b/latest/extensions/api/classes/renderer.component.spinner/index.html index 147f32e478..5c596f63b7 100644 --- a/latest/extensions/api/classes/renderer.component.spinner/index.html +++ b/latest/extensions/api/classes/renderer.component.spinner/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.spinner/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.spinner/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.statusbrick/index.html b/latest/extensions/api/classes/renderer.component.statusbrick/index.html index dff217d672..f47a57ecf6 100644 --- a/latest/extensions/api/classes/renderer.component.statusbrick/index.html +++ b/latest/extensions/api/classes/renderer.component.statusbrick/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.statusbrick/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.statusbrick/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.stepper/index.html b/latest/extensions/api/classes/renderer.component.stepper/index.html index 153630ae08..90f78e97c3 100644 --- a/latest/extensions/api/classes/renderer.component.stepper/index.html +++ b/latest/extensions/api/classes/renderer.component.stepper/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.stepper/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.stepper/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.subtitle/index.html b/latest/extensions/api/classes/renderer.component.subtitle/index.html index 0152492bc6..04d2556b55 100644 --- a/latest/extensions/api/classes/renderer.component.subtitle/index.html +++ b/latest/extensions/api/classes/renderer.component.subtitle/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.subtitle/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.subtitle/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tab/index.html b/latest/extensions/api/classes/renderer.component.tab/index.html index 53db781bea..50ca6f66ca 100644 --- a/latest/extensions/api/classes/renderer.component.tab/index.html +++ b/latest/extensions/api/classes/renderer.component.tab/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tab/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tab/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.table/index.html b/latest/extensions/api/classes/renderer.component.table/index.html index 13adfc7f00..77c8b9ca93 100644 --- a/latest/extensions/api/classes/renderer.component.table/index.html +++ b/latest/extensions/api/classes/renderer.component.table/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.table/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.table/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tablecell/index.html b/latest/extensions/api/classes/renderer.component.tablecell/index.html index 76c72320bc..865ad194a1 100644 --- a/latest/extensions/api/classes/renderer.component.tablecell/index.html +++ b/latest/extensions/api/classes/renderer.component.tablecell/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tablecell/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tablecell/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tablehead/index.html b/latest/extensions/api/classes/renderer.component.tablehead/index.html index 8442cc27c4..21218c38f2 100644 --- a/latest/extensions/api/classes/renderer.component.tablehead/index.html +++ b/latest/extensions/api/classes/renderer.component.tablehead/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tablehead/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tablehead/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tablerow/index.html b/latest/extensions/api/classes/renderer.component.tablerow/index.html index 7e914a80d8..920cbf114c 100644 --- a/latest/extensions/api/classes/renderer.component.tablerow/index.html +++ b/latest/extensions/api/classes/renderer.component.tablerow/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tablerow/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tablerow/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tabs/index.html b/latest/extensions/api/classes/renderer.component.tabs/index.html index 86a9f4125d..74015d003e 100644 --- a/latest/extensions/api/classes/renderer.component.tabs/index.html +++ b/latest/extensions/api/classes/renderer.component.tabs/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tabs/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tabs/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.terminalstore/index.html b/latest/extensions/api/classes/renderer.component.terminalstore/index.html index e424234103..7ec17006db 100644 --- a/latest/extensions/api/classes/renderer.component.terminalstore/index.html +++ b/latest/extensions/api/classes/renderer.component.terminalstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.terminalstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.terminalstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.tooltip/index.html b/latest/extensions/api/classes/renderer.component.tooltip/index.html index 81b7c1b4c4..b522b733b4 100644 --- a/latest/extensions/api/classes/renderer.component.tooltip/index.html +++ b/latest/extensions/api/classes/renderer.component.tooltip/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.tooltip/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.tooltip/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.wizard/index.html b/latest/extensions/api/classes/renderer.component.wizard/index.html index 54d354445e..64b05f25f1 100644 --- a/latest/extensions/api/classes/renderer.component.wizard/index.html +++ b/latest/extensions/api/classes/renderer.component.wizard/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.wizard/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.wizard/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.wizardlayout/index.html b/latest/extensions/api/classes/renderer.component.wizardlayout/index.html index 351bf48eb2..c1acd361ed 100644 --- a/latest/extensions/api/classes/renderer.component.wizardlayout/index.html +++ b/latest/extensions/api/classes/renderer.component.wizardlayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.wizardlayout/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.wizardlayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.component.wizardstep/index.html b/latest/extensions/api/classes/renderer.component.wizardstep/index.html index b3610bb7b0..ed80e7f45b 100644 --- a/latest/extensions/api/classes/renderer.component.wizardstep/index.html +++ b/latest/extensions/api/classes/renderer.component.wizardstep/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.component.wizardstep/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.component.wizardstep/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.ipc/index.html b/latest/extensions/api/classes/renderer.ipc/index.html index 9a00ed7fa4..9f09919db5 100644 --- a/latest/extensions/api/classes/renderer.ipc/index.html +++ b/latest/extensions/api/classes/renderer.ipc/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.ipc/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.ipc/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.clusterrole/index.html b/latest/extensions/api/classes/renderer.k8sapi.clusterrole/index.html index dbf2f8edf9..456ea5005f 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.clusterrole/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.clusterrole/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.clusterrole/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrole/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html b/latest/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html index 1685169030..9d1b5c871d 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.clusterrolebinding/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrolebinding/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.configmap/index.html b/latest/extensions/api/classes/renderer.k8sapi.configmap/index.html index 972460194f..60a5ae9e24 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.configmap/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.configmap/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.configmap/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.configmap/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html index 949f9e4936..baa5e22e86 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.configmapsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.configmapsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html b/latest/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html index cd97d02f45..08548e709c 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.crdresourcestore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.crdresourcestore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.crdstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.crdstore/index.html index bfd577d6dc..6d3dda6ef1 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.crdstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.crdstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.crdstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.crdstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.cronjob/index.html b/latest/extensions/api/classes/renderer.k8sapi.cronjob/index.html index 78a108cd5f..029a736efe 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.cronjob/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.cronjob/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.cronjob/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.cronjob/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html index 70c17ad1a3..4481e822ed 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.cronjobstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.cronjobstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html b/latest/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html index 57e1d9d405..a749061d5b 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.customresourcedefinition/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.customresourcedefinition/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.daemonset/index.html b/latest/extensions/api/classes/renderer.k8sapi.daemonset/index.html index 574fe9f989..2ce17ff08a 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.daemonset/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.daemonset/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.daemonset/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.daemonset/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html index bbd2d5e0b0..6d026f4d02 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.daemonsetstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.daemonsetstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.deployment/index.html b/latest/extensions/api/classes/renderer.k8sapi.deployment/index.html index 45e98b9926..34b4dd82da 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.deployment/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.deployment/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.deployment/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.deployment/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html index 99048b6b08..505325cb70 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.deploymentapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html index d1df00d37f..044b1eb8e2 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.deploymentstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.endpoint/index.html b/latest/extensions/api/classes/renderer.k8sapi.endpoint/index.html index a3fc507ad3..472aae438c 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.endpoint/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.endpoint/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.endpoint/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.endpoint/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.endpointstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.endpointstore/index.html index 143ae97da4..780bca1f9a 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.endpointstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.endpointstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.endpointstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.endpointstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.eventstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.eventstore/index.html index eb16687ff5..708e7efa82 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.eventstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.eventstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.eventstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.eventstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html b/latest/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html index 688d9f71fa..ee2789cc25 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.hpastore/index.html b/latest/extensions/api/classes/renderer.k8sapi.hpastore/index.html index 0cf01680aa..1c379f7dc2 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.hpastore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.hpastore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.hpastore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.hpastore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.ingress/index.html b/latest/extensions/api/classes/renderer.k8sapi.ingress/index.html index ff8a159919..56447f21b6 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.ingress/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.ingress/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.ingress/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.ingress/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.ingressapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.ingressapi/index.html index caa75e433d..2ee2372a18 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.ingressapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.ingressapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.ingressapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.ingressapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.ingressstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.ingressstore/index.html index 6f22ad86f8..bea00cff4f 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.ingressstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.ingressstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.ingressstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.ingressstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.job/index.html b/latest/extensions/api/classes/renderer.k8sapi.job/index.html index 9ee9d59bdb..8957559f35 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.job/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.job/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.job/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.job/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.jobstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.jobstore/index.html index 92d6ae8e39..9c16ea469a 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.jobstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.jobstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.jobstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.jobstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.kubeapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.kubeapi/index.html index 9028e41d0e..5fbfd265bb 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.kubeapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.kubeapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.kubeapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.kubeapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.kubeevent/index.html b/latest/extensions/api/classes/renderer.k8sapi.kubeevent/index.html index b89fb49ce5..89e12fc02b 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.kubeevent/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.kubeevent/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.kubeevent/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.kubeevent/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.kubeobject/index.html b/latest/extensions/api/classes/renderer.k8sapi.kubeobject/index.html index 60200c2b7e..9ce8ef2ffe 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.kubeobject/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.kubeobject/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.kubeobject/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobject/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html index 6fb09697e3..d6844e7220 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.kubeobjectstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobjectstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.limitrange/index.html b/latest/extensions/api/classes/renderer.k8sapi.limitrange/index.html index a1f45e4f47..d66fce8a43 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.limitrange/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.limitrange/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.limitrange/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.limitrange/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html index 9d25e721be..ae1a6659f9 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.limitrangesstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.limitrangesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.namespace/index.html b/latest/extensions/api/classes/renderer.k8sapi.namespace/index.html index a6fa5baec6..b2a2a057d6 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.namespace/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.namespace/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.namespace/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.namespace/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.namespacestore/index.html b/latest/extensions/api/classes/renderer.k8sapi.namespacestore/index.html index 929a5c4417..0369da75c2 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.namespacestore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.namespacestore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.namespacestore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.namespacestore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html b/latest/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html index 263e402849..62be990c85 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.networkpolicy/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicy/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html b/latest/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html index aadb2add01..496400c4a4 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.networkpolicystore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicystore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.node/index.html b/latest/extensions/api/classes/renderer.k8sapi.node/index.html index 05d6c4aa75..03b1bd3d4a 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.node/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.node/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.node/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.node/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.nodesapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.nodesapi/index.html index 96e7c11e83..d02d2a64cb 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.nodesapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.nodesapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.nodesapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.nodesapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.nodesstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.nodesstore/index.html index bb2fbb74a7..4e749f3093 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.nodesstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.nodesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.nodesstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.nodesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html b/latest/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html index c69285126c..f79f582896 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.persistentvolume/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolume/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html index 365e772976..02b643242c 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html index c1525cbb60..1eb29d87a0 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html index d5aa88d6b7..a6fd999e47 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.pod/index.html b/latest/extensions/api/classes/renderer.k8sapi.pod/index.html index 3355068576..2ab1dca9ab 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.pod/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.pod/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.pod/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.pod/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html b/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html index 20326bbabc..1af9f27d1c 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html index f60b278c65..66a106272b 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.podsapi/index.html b/latest/extensions/api/classes/renderer.k8sapi.podsapi/index.html index 379792e327..cff682ac29 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.podsapi/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.podsapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.podsapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.podsapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.podsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.podsstore/index.html index 23ff3a701f..b527d7fd33 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.podsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.podsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.podsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.podsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.replicaset/index.html b/latest/extensions/api/classes/renderer.k8sapi.replicaset/index.html index fb537f6d8b..3bcb4794f6 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.replicaset/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.replicaset/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.replicaset/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.replicaset/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html index 163d56d34f..af9432b42f 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.replicasetstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.replicasetstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.resourcequota/index.html b/latest/extensions/api/classes/renderer.k8sapi.resourcequota/index.html index e57339a32c..0af8c32995 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.resourcequota/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.resourcequota/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.resourcequota/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequota/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html index a10cac8d51..d18f0ab284 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.resourcequotasstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequotasstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.resourcestack/index.html b/latest/extensions/api/classes/renderer.k8sapi.resourcestack/index.html index 2dc7d5a90f..ba7dd5cb74 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.resourcestack/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.resourcestack/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.resourcestack/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.resourcestack/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.role/index.html b/latest/extensions/api/classes/renderer.k8sapi.role/index.html index dba3c845fe..13e4cfedf1 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.role/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.role/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.role/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.role/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.rolebinding/index.html b/latest/extensions/api/classes/renderer.k8sapi.rolebinding/index.html index 1edbaff952..ba2e808510 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.rolebinding/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.rolebinding/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.rolebinding/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.rolebinding/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html index aa51c64187..42228b0f12 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.rolebindingsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.rolebindingsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.rolesstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.rolesstore/index.html index 7a66b8adfd..1eaffc2e3f 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.rolesstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.rolesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.rolesstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.rolesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.secret/index.html b/latest/extensions/api/classes/renderer.k8sapi.secret/index.html index 5a908eacef..0bce263d80 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.secret/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.secret/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.secret/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.secret/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.secretsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.secretsstore/index.html index ae8a391776..b3ac5f91c6 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.secretsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.secretsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.secretsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.secretsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.service/index.html b/latest/extensions/api/classes/renderer.k8sapi.service/index.html index d882be2041..83accb3f3b 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.service/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.service/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.service/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.service/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html b/latest/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html index 872dd0b270..1ef59fb67f 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.serviceaccount/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccount/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html index ae98b89242..7fb0175a82 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.servicestore/index.html b/latest/extensions/api/classes/renderer.k8sapi.servicestore/index.html index 1845c61d28..e1e2c52469 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.servicestore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.servicestore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.servicestore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.servicestore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.statefulset/index.html b/latest/extensions/api/classes/renderer.k8sapi.statefulset/index.html index 4b761c1e0e..29a608eb5b 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.statefulset/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.statefulset/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.statefulset/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.statefulset/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html index 000c6d716b..766ecaa63a 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.statefulsetstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.statefulsetstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.storageclass/index.html b/latest/extensions/api/classes/renderer.k8sapi.storageclass/index.html index 0e81359fce..54f4473d56 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.storageclass/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.storageclass/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.storageclass/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.storageclass/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html index 69a9eafb6a..5c9ac322ee 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.storageclassstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.storageclassstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html b/latest/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html index c80e017f40..b68d4a96c9 100644 --- a/latest/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html +++ b/latest/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.k8sapi.volumeclaimstore/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.k8sapi.volumeclaimstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.lensextension/index.html b/latest/extensions/api/classes/renderer.lensextension/index.html index e2ddabb072..fda3b2049b 100644 --- a/latest/extensions/api/classes/renderer.lensextension/index.html +++ b/latest/extensions/api/classes/renderer.lensextension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.lensextension/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.lensextension/... \ No newline at end of file diff --git a/latest/extensions/api/classes/renderer.navigation.pageparam/index.html b/latest/extensions/api/classes/renderer.navigation.pageparam/index.html index 1a255ccc8c..13975dafa7 100644 --- a/latest/extensions/api/classes/renderer.navigation.pageparam/index.html +++ b/latest/extensions/api/classes/renderer.navigation.pageparam/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/classes/renderer.navigation.pageparam/... + Redirecting to ../../../../../v5.2.6/extensions/api/classes/renderer.navigation.pageparam/... \ No newline at end of file diff --git a/latest/extensions/api/enums/renderer.component.notificationstatus/index.html b/latest/extensions/api/enums/renderer.component.notificationstatus/index.html index e5721546b1..a56b93ba8d 100644 --- a/latest/extensions/api/enums/renderer.component.notificationstatus/index.html +++ b/latest/extensions/api/enums/renderer.component.notificationstatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/enums/renderer.component.notificationstatus/... + Redirecting to ../../../../../v5.2.6/extensions/api/enums/renderer.component.notificationstatus/... \ No newline at end of file diff --git a/latest/extensions/api/enums/renderer.component.tooltipposition/index.html b/latest/extensions/api/enums/renderer.component.tooltipposition/index.html index 596e0acbe6..4bc5dc511a 100644 --- a/latest/extensions/api/enums/renderer.component.tooltipposition/index.html +++ b/latest/extensions/api/enums/renderer.component.tooltipposition/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/enums/renderer.component.tooltipposition/... + Redirecting to ../../../../../v5.2.6/extensions/api/enums/renderer.component.tooltipposition/... \ No newline at end of file diff --git a/latest/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html b/latest/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html index 8d7882becc..7553f38352 100644 --- a/latest/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html +++ b/latest/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/... + Redirecting to ../../../../../v5.2.6/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/... \ No newline at end of file diff --git a/latest/extensions/api/index.html b/latest/extensions/api/index.html index ff08643a2e..c50efe3de7 100644 --- a/latest/extensions/api/index.html +++ b/latest/extensions/api/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v5.2.5/extensions/api/... + Redirecting to ../../../v5.2.6/extensions/api/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html b/latest/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html index 2354cb797f..0bb3277a61 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogcategoryevents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryevents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html b/latest/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html index 7b15c9e3b0..031ff9e6a9 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogcategoryspec/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryspec/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html b/latest/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html index d823b77a13..9bbee8122f 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogcategoryversion/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryversion/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html index 2052235858..d3253a9fe5 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentityactioncontext/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentityactioncontext/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html index 7d5a2c5ccf..fca69fda65 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentityaddmenu/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenu/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html index 83b6db4da2..58e290ceac 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html index d47d21eba6..56f93c705b 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html index 69cba839e4..e7646437c9 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitydata/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitydata/index.html index e1efe5e494..0edf028fb5 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitydata/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitydata/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitydata/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitydata/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html index f1536fd267..9b79e4fabb 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitykinddata/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitykinddata/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html index d43e05ef6f..bef4b286d3 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitymetadata/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitymetadata/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html index 6ad5df2dec..deeec55709 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html index fbc01bafb0..285e36e764 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html b/latest/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html index 0fdc04b1d4..6f34b8eb0b 100644 --- a/latest/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html +++ b/latest/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.catalogentitystatus/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.catalogentitystatus/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html b/latest/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html index e5028b76fd..f6a5ba53c0 100644 --- a/latest/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html +++ b/latest/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html index c962030dff..3c9435a415 100644 --- a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html +++ b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html index 7014777d4f..3d1d4c9ce6 100644 --- a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html +++ b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.kubernetesclusterspec/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterspec/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html index 636b718e5c..32a8a202af 100644 --- a/latest/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html +++ b/latest/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.catalog.weblinkstatus/index.html b/latest/extensions/api/interfaces/common.catalog.weblinkstatus/index.html index 88d8bfc95a..968194437a 100644 --- a/latest/extensions/api/interfaces/common.catalog.weblinkstatus/index.html +++ b/latest/extensions/api/interfaces/common.catalog.weblinkstatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.catalog.weblinkstatus/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.catalog.weblinkstatus/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.apppreferencecomponents/index.html b/latest/extensions/api/interfaces/common.types.apppreferencecomponents/index.html index 72f4e13219..60e816cf43 100644 --- a/latest/extensions/api/interfaces/common.types.apppreferencecomponents/index.html +++ b/latest/extensions/api/interfaces/common.types.apppreferencecomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.apppreferencecomponents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.apppreferencecomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.apppreferenceregistration/index.html b/latest/extensions/api/interfaces/common.types.apppreferenceregistration/index.html index 4094e3744b..5b43e50a4f 100644 --- a/latest/extensions/api/interfaces/common.types.apppreferenceregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.apppreferenceregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.apppreferenceregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.apppreferenceregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html b/latest/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html index 51b14a3cc0..1f352b2483 100644 --- a/latest/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html +++ b/latest/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.clusterpagemenucomponents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.clusterpagemenucomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html b/latest/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html index 7836eb47f7..f0cf9e87a3 100644 --- a/latest/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.clusterpagemenuregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.clusterpagemenuregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html b/latest/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html index fa107cab55..b4eac5d194 100644 --- a/latest/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html +++ b/latest/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html b/latest/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html index 8cf1189eb4..9b53f1ae09 100644 --- a/latest/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.kubeobjectdetailregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html b/latest/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html index f6b9dc0419..88b6ce3dd0 100644 --- a/latest/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html +++ b/latest/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.kubeobjectmenucomponents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenucomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html b/latest/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html index d817335c1d..23fa5c4761 100644 --- a/latest/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.kubeobjectmenuregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenuregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html b/latest/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html index 300b8f1410..4bcaa86433 100644 --- a/latest/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.kubeobjectstatusregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.kubeobjectstatusregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.pagecomponentprops/index.html b/latest/extensions/api/interfaces/common.types.pagecomponentprops/index.html index 28aee18cb2..29a9b7a17a 100644 --- a/latest/extensions/api/interfaces/common.types.pagecomponentprops/index.html +++ b/latest/extensions/api/interfaces/common.types.pagecomponentprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.pagecomponentprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.pagecomponentprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.pagecomponents/index.html b/latest/extensions/api/interfaces/common.types.pagecomponents/index.html index 920c8d3e84..ff687d91fb 100644 --- a/latest/extensions/api/interfaces/common.types.pagecomponents/index.html +++ b/latest/extensions/api/interfaces/common.types.pagecomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.pagecomponents/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.pagecomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.pageparams/index.html b/latest/extensions/api/interfaces/common.types.pageparams/index.html index 87d9ca1ee5..9eaf4b3c75 100644 --- a/latest/extensions/api/interfaces/common.types.pageparams/index.html +++ b/latest/extensions/api/interfaces/common.types.pageparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.pageparams/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.pageparams/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.pageregistration/index.html b/latest/extensions/api/interfaces/common.types.pageregistration/index.html index 830e06591d..49b8870f71 100644 --- a/latest/extensions/api/interfaces/common.types.pageregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.pageregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.pageregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.pageregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.pagetarget/index.html b/latest/extensions/api/interfaces/common.types.pagetarget/index.html index 614c53a806..6bb7f436a6 100644 --- a/latest/extensions/api/interfaces/common.types.pagetarget/index.html +++ b/latest/extensions/api/interfaces/common.types.pagetarget/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.pagetarget/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.pagetarget/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html b/latest/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html index 3633375930..88f197fa88 100644 --- a/latest/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.protocolhandlerregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.protocolhandlerregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.protocolroutehandler/index.html b/latest/extensions/api/interfaces/common.types.protocolroutehandler/index.html index 4a6f88ec57..883b517c72 100644 --- a/latest/extensions/api/interfaces/common.types.protocolroutehandler/index.html +++ b/latest/extensions/api/interfaces/common.types.protocolroutehandler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.protocolroutehandler/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.protocolroutehandler/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.protocolrouteparams/index.html b/latest/extensions/api/interfaces/common.types.protocolrouteparams/index.html index 95d9c59e38..b5d66b3a39 100644 --- a/latest/extensions/api/interfaces/common.types.protocolrouteparams/index.html +++ b/latest/extensions/api/interfaces/common.types.protocolrouteparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.protocolrouteparams/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.protocolrouteparams/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.registeredpage/index.html b/latest/extensions/api/interfaces/common.types.registeredpage/index.html index 7901eb5de7..8d289d13a4 100644 --- a/latest/extensions/api/interfaces/common.types.registeredpage/index.html +++ b/latest/extensions/api/interfaces/common.types.registeredpage/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.registeredpage/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.registeredpage/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/common.types.statusbarregistration/index.html b/latest/extensions/api/interfaces/common.types.statusbarregistration/index.html index 53e189a83b..7ee33604c7 100644 --- a/latest/extensions/api/interfaces/common.types.statusbarregistration/index.html +++ b/latest/extensions/api/interfaces/common.types.statusbarregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/common.types.statusbarregistration/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/common.types.statusbarregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.badgeprops/index.html b/latest/extensions/api/interfaces/renderer.component.badgeprops/index.html index e72f50df21..068594672c 100644 --- a/latest/extensions/api/interfaces/renderer.component.badgeprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.badgeprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.badgeprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.badgeprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.buttonprops/index.html b/latest/extensions/api/interfaces/renderer.component.buttonprops/index.html index 05bb334711..a77c490114 100644 --- a/latest/extensions/api/interfaces/renderer.component.buttonprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.buttonprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.buttonprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.buttonprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.checkboxprops/index.html b/latest/extensions/api/interfaces/renderer.component.checkboxprops/index.html index 507e28b9d2..50cb4322ca 100644 --- a/latest/extensions/api/interfaces/renderer.component.checkboxprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.checkboxprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.checkboxprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.checkboxprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html b/latest/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html index 4f534619aa..29e6d6331e 100644 --- a/latest/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html +++ b/latest/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html b/latest/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html index 722bae05af..f1d6e01dda 100644 --- a/latest/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html +++ b/latest/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.confirmdialogparams/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogparams/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html b/latest/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html index 8528016b51..25f7de6349 100644 --- a/latest/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.confirmdialogprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.dialogprops/index.html b/latest/extensions/api/interfaces/renderer.component.dialogprops/index.html index 5fede5ea15..f76a3a4a69 100644 --- a/latest/extensions/api/interfaces/renderer.component.dialogprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.dialogprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.dialogprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.dialogprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html b/latest/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html index 9679d4c612..d506f1e388 100644 --- a/latest/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.draweritemlabelsprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.draweritemlabelsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.draweritemprops/index.html b/latest/extensions/api/interfaces/renderer.component.draweritemprops/index.html index 4af95f8163..5f8cd23ec9 100644 --- a/latest/extensions/api/interfaces/renderer.component.draweritemprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.draweritemprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.draweritemprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.draweritemprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html b/latest/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html index 4a833eac57..0ed7c0d779 100644 --- a/latest/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.drawerprops/index.html b/latest/extensions/api/interfaces/renderer.component.drawerprops/index.html index 8ea7aa516c..53829e0b8c 100644 --- a/latest/extensions/api/interfaces/renderer.component.drawerprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.drawerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.drawerprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.drawerprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.drawertitleprops/index.html b/latest/extensions/api/interfaces/renderer.component.drawertitleprops/index.html index f2920721df..ac0f81ad0b 100644 --- a/latest/extensions/api/interfaces/renderer.component.drawertitleprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.drawertitleprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.drawertitleprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.drawertitleprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.groupselectoption/index.html b/latest/extensions/api/interfaces/renderer.component.groupselectoption/index.html index f1de5beae9..a61d609cec 100644 --- a/latest/extensions/api/interfaces/renderer.component.groupselectoption/index.html +++ b/latest/extensions/api/interfaces/renderer.component.groupselectoption/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.groupselectoption/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.groupselectoption/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.icondatafnarg/index.html b/latest/extensions/api/interfaces/renderer.component.icondatafnarg/index.html index 3da19868ba..4abb9145a2 100644 --- a/latest/extensions/api/interfaces/renderer.component.icondatafnarg/index.html +++ b/latest/extensions/api/interfaces/renderer.component.icondatafnarg/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.icondatafnarg/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.icondatafnarg/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.iconprops/index.html b/latest/extensions/api/interfaces/renderer.component.iconprops/index.html index 1db5d6146a..8d1c0639cc 100644 --- a/latest/extensions/api/interfaces/renderer.component.iconprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.iconprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.iconprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.iconprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.inputvalidator/index.html b/latest/extensions/api/interfaces/renderer.component.inputvalidator/index.html index 29e58fb87d..58b6c61575 100644 --- a/latest/extensions/api/interfaces/renderer.component.inputvalidator/index.html +++ b/latest/extensions/api/interfaces/renderer.component.inputvalidator/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.inputvalidator/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.inputvalidator/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html b/latest/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html index 4105c5b80b..ca16ac439e 100644 --- a/latest/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html b/latest/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html index 4d24e2321a..10c416a287 100644 --- a/latest/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html b/latest/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html index 03bf511f1d..8e758fb9b0 100644 --- a/latest/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html b/latest/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html index 139140bf64..651cf9bab6 100644 --- a/latest/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html b/latest/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html index edeeccb49a..22c358043c 100644 --- a/latest/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.lineprogressprops/index.html b/latest/extensions/api/interfaces/renderer.component.lineprogressprops/index.html index 263cd4f74f..c67621bcc6 100644 --- a/latest/extensions/api/interfaces/renderer.component.lineprogressprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.lineprogressprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.lineprogressprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.lineprogressprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.menuactionsprops/index.html b/latest/extensions/api/interfaces/renderer.component.menuactionsprops/index.html index 8da2600f0c..a68e2c1e49 100644 --- a/latest/extensions/api/interfaces/renderer.component.menuactionsprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.menuactionsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.menuactionsprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.menuactionsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.menuitemprops/index.html b/latest/extensions/api/interfaces/renderer.component.menuitemprops/index.html index de31dc44ee..e5933e9215 100644 --- a/latest/extensions/api/interfaces/renderer.component.menuitemprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.menuitemprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.menuitemprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.menuitemprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.menuposition/index.html b/latest/extensions/api/interfaces/renderer.component.menuposition/index.html index 03e086d832..06ef791b51 100644 --- a/latest/extensions/api/interfaces/renderer.component.menuposition/index.html +++ b/latest/extensions/api/interfaces/renderer.component.menuposition/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.menuposition/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.menuposition/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.menuprops/index.html b/latest/extensions/api/interfaces/renderer.component.menuprops/index.html index 4cf9d30523..d7d2dfa88a 100644 --- a/latest/extensions/api/interfaces/renderer.component.menuprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.menuprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.menuprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.menuprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.notification/index.html b/latest/extensions/api/interfaces/renderer.component.notification/index.html index c8b5714590..c8f0b7c22d 100644 --- a/latest/extensions/api/interfaces/renderer.component.notification/index.html +++ b/latest/extensions/api/interfaces/renderer.component.notification/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.notification/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.notification/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.radiogroupprops/index.html b/latest/extensions/api/interfaces/renderer.component.radiogroupprops/index.html index 95739dfca7..810e90947c 100644 --- a/latest/extensions/api/interfaces/renderer.component.radiogroupprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.radiogroupprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.radiogroupprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.radiogroupprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.selectoption/index.html b/latest/extensions/api/interfaces/renderer.component.selectoption/index.html index ca77fceef7..1bae4df58e 100644 --- a/latest/extensions/api/interfaces/renderer.component.selectoption/index.html +++ b/latest/extensions/api/interfaces/renderer.component.selectoption/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.selectoption/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.selectoption/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.selectprops/index.html b/latest/extensions/api/interfaces/renderer.component.selectprops/index.html index 54d44c9d85..1f2c61e391 100644 --- a/latest/extensions/api/interfaces/renderer.component.selectprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.selectprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.selectprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.selectprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html b/latest/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html index 6fb58dba36..a0e648cbfe 100644 --- a/latest/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.settinglayoutprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.settinglayoutprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.sliderprops/index.html b/latest/extensions/api/interfaces/renderer.component.sliderprops/index.html index caf6bfccc1..5adb849663 100644 --- a/latest/extensions/api/interfaces/renderer.component.sliderprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.sliderprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.sliderprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.sliderprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.spinnerprops/index.html b/latest/extensions/api/interfaces/renderer.component.spinnerprops/index.html index 6aad2a0906..6f89bdc00b 100644 --- a/latest/extensions/api/interfaces/renderer.component.spinnerprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.spinnerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.spinnerprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.spinnerprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.statusbrickprops/index.html b/latest/extensions/api/interfaces/renderer.component.statusbrickprops/index.html index e3321d770b..c0f830b246 100644 --- a/latest/extensions/api/interfaces/renderer.component.statusbrickprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.statusbrickprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.statusbrickprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.statusbrickprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.stepperprops/index.html b/latest/extensions/api/interfaces/renderer.component.stepperprops/index.html index 8a44f9865a..8b3c0f20ec 100644 --- a/latest/extensions/api/interfaces/renderer.component.stepperprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.stepperprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.stepperprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.stepperprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tablayoutprops/index.html b/latest/extensions/api/interfaces/renderer.component.tablayoutprops/index.html index 4e998bc772..942ec5b23c 100644 --- a/latest/extensions/api/interfaces/renderer.component.tablayoutprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tablayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tablayoutprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tablayoutprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tablayoutroute/index.html b/latest/extensions/api/interfaces/renderer.component.tablayoutroute/index.html index d4723aed1c..e5a56a9e10 100644 --- a/latest/extensions/api/interfaces/renderer.component.tablayoutroute/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tablayoutroute/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tablayoutroute/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tablayoutroute/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tablecellprops/index.html b/latest/extensions/api/interfaces/renderer.component.tablecellprops/index.html index 73697da1a9..1d2a19f5b8 100644 --- a/latest/extensions/api/interfaces/renderer.component.tablecellprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tablecellprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tablecellprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tablecellprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tableheadprops/index.html b/latest/extensions/api/interfaces/renderer.component.tableheadprops/index.html index fbf632c039..c715880812 100644 --- a/latest/extensions/api/interfaces/renderer.component.tableheadprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tableheadprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tableheadprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tableheadprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tableprops/index.html b/latest/extensions/api/interfaces/renderer.component.tableprops/index.html index 869c96867a..13b58b73d8 100644 --- a/latest/extensions/api/interfaces/renderer.component.tableprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tableprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tableprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tableprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tablerowprops/index.html b/latest/extensions/api/interfaces/renderer.component.tablerowprops/index.html index 815c4a8ed0..de5394be8e 100644 --- a/latest/extensions/api/interfaces/renderer.component.tablerowprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tablerowprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tablerowprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tablerowprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tabprops/index.html b/latest/extensions/api/interfaces/renderer.component.tabprops/index.html index fc380c6905..b50f7351f7 100644 --- a/latest/extensions/api/interfaces/renderer.component.tabprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tabprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tabprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tabprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tabsprops/index.html b/latest/extensions/api/interfaces/renderer.component.tabsprops/index.html index 41a3ffc2ad..00c743e9f2 100644 --- a/latest/extensions/api/interfaces/renderer.component.tabsprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tabsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tabsprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tabsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html b/latest/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html index c5da176529..7a71e7b6d3 100644 --- a/latest/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tooltipcontentformatters/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tooltipcontentformatters/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html b/latest/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html index 90ca32b49d..e741144a6f 100644 --- a/latest/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.tooltipprops/index.html b/latest/extensions/api/interfaces/renderer.component.tooltipprops/index.html index bf0979a529..9a692474d0 100644 --- a/latest/extensions/api/interfaces/renderer.component.tooltipprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.tooltipprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.tooltipprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.tooltipprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html b/latest/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html index f1b53d02df..15163918e0 100644 --- a/latest/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.wizardlayoutprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.wizardlayoutprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.wizardprops/index.html b/latest/extensions/api/interfaces/renderer.component.wizardprops/index.html index 30e6330d48..318374b2e6 100644 --- a/latest/extensions/api/interfaces/renderer.component.wizardprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.wizardprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.wizardprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.wizardprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.component.wizardstepprops/index.html b/latest/extensions/api/interfaces/renderer.component.wizardstepprops/index.html index ecbe52b75d..6bcfbe0749 100644 --- a/latest/extensions/api/interfaces/renderer.component.wizardstepprops/index.html +++ b/latest/extensions/api/interfaces/renderer.component.wizardstepprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.component.wizardstepprops/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.component.wizardstepprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html b/latest/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html index 8d0a6879fc..696d2a58ca 100644 --- a/latest/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html +++ b/latest/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html b/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html index 1bab7b2475..45e2640534 100644 --- a/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html +++ b/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html b/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html index 73d16f2e41..ee7daf8b43 100644 --- a/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html +++ b/latest/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html b/latest/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html index 6ad9522803..62d5d3edee 100644 --- a/latest/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html +++ b/latest/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.k8sapi.isecretref/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.k8sapi.isecretref/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html b/latest/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html index 19e1a0573e..02a469b9b6 100644 --- a/latest/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html +++ b/latest/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.navigation.pageparaminit/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.navigation.pageparaminit/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/renderer.navigation.urlparams/index.html b/latest/extensions/api/interfaces/renderer.navigation.urlparams/index.html index 978d6cafa6..d0de952fbe 100644 --- a/latest/extensions/api/interfaces/renderer.navigation.urlparams/index.html +++ b/latest/extensions/api/interfaces/renderer.navigation.urlparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/interfaces/renderer.navigation.urlparams/... + Redirecting to ../../../../../v5.2.6/extensions/api/interfaces/renderer.navigation.urlparams/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.app/index.html b/latest/extensions/api/modules/common.app/index.html index 3aacfb7fc4..39e9358359 100644 --- a/latest/extensions/api/modules/common.app/index.html +++ b/latest/extensions/api/modules/common.app/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.app/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.app/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.catalog/index.html b/latest/extensions/api/modules/common.catalog/index.html index 84b87e684f..f049c9b5a9 100644 --- a/latest/extensions/api/modules/common.catalog/index.html +++ b/latest/extensions/api/modules/common.catalog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.catalog/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.catalog/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.eventbus/index.html b/latest/extensions/api/modules/common.eventbus/index.html index a0a637ec74..590a4ddf26 100644 --- a/latest/extensions/api/modules/common.eventbus/index.html +++ b/latest/extensions/api/modules/common.eventbus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.eventbus/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.eventbus/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.store/index.html b/latest/extensions/api/modules/common.store/index.html index dced3dba05..fe95401632 100644 --- a/latest/extensions/api/modules/common.store/index.html +++ b/latest/extensions/api/modules/common.store/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.store/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.store/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.types/index.html b/latest/extensions/api/modules/common.types/index.html index 082b093076..82e32c1a6a 100644 --- a/latest/extensions/api/modules/common.types/index.html +++ b/latest/extensions/api/modules/common.types/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.types/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.types/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common.util/index.html b/latest/extensions/api/modules/common.util/index.html index dc378dff6b..e384ae0c81 100644 --- a/latest/extensions/api/modules/common.util/index.html +++ b/latest/extensions/api/modules/common.util/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common.util/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common.util/... \ No newline at end of file diff --git a/latest/extensions/api/modules/common/index.html b/latest/extensions/api/modules/common/index.html index cbc7ed81b6..49062ab7cb 100644 --- a/latest/extensions/api/modules/common/index.html +++ b/latest/extensions/api/modules/common/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/common/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/common/... \ No newline at end of file diff --git a/latest/extensions/api/modules/index.html b/latest/extensions/api/modules/index.html index 9a819b5a25..fab8cb77f9 100644 --- a/latest/extensions/api/modules/index.html +++ b/latest/extensions/api/modules/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/api/modules/... + Redirecting to ../../../../v5.2.6/extensions/api/modules/... \ No newline at end of file diff --git a/latest/extensions/api/modules/main.catalog/index.html b/latest/extensions/api/modules/main.catalog/index.html index 77d2eb571c..a2d41db89a 100644 --- a/latest/extensions/api/modules/main.catalog/index.html +++ b/latest/extensions/api/modules/main.catalog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/main.catalog/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/main.catalog/... \ No newline at end of file diff --git a/latest/extensions/api/modules/main.k8sapi/index.html b/latest/extensions/api/modules/main.k8sapi/index.html index 5f5753935c..75baf8f31b 100644 --- a/latest/extensions/api/modules/main.k8sapi/index.html +++ b/latest/extensions/api/modules/main.k8sapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/main.k8sapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/main.k8sapi/... \ No newline at end of file diff --git a/latest/extensions/api/modules/main.navigation/index.html b/latest/extensions/api/modules/main.navigation/index.html index ccd078e306..72724dd4bf 100644 --- a/latest/extensions/api/modules/main.navigation/index.html +++ b/latest/extensions/api/modules/main.navigation/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/main.navigation/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/main.navigation/... \ No newline at end of file diff --git a/latest/extensions/api/modules/main/index.html b/latest/extensions/api/modules/main/index.html index 44ce99968e..9d0eae101e 100644 --- a/latest/extensions/api/modules/main/index.html +++ b/latest/extensions/api/modules/main/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/main/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/main/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer.catalog/index.html b/latest/extensions/api/modules/renderer.catalog/index.html index 964ff93184..01c59299f7 100644 --- a/latest/extensions/api/modules/renderer.catalog/index.html +++ b/latest/extensions/api/modules/renderer.catalog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer.catalog/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer.catalog/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer.component/index.html b/latest/extensions/api/modules/renderer.component/index.html index ea0a5d97cd..eb1f9d6b27 100644 --- a/latest/extensions/api/modules/renderer.component/index.html +++ b/latest/extensions/api/modules/renderer.component/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer.component/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer.component/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer.k8sapi/index.html b/latest/extensions/api/modules/renderer.k8sapi/index.html index 24ab7a1d32..cb67fbc337 100644 --- a/latest/extensions/api/modules/renderer.k8sapi/index.html +++ b/latest/extensions/api/modules/renderer.k8sapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer.k8sapi/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer.k8sapi/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer.navigation/index.html b/latest/extensions/api/modules/renderer.navigation/index.html index e9a956287f..7a052594c9 100644 --- a/latest/extensions/api/modules/renderer.navigation/index.html +++ b/latest/extensions/api/modules/renderer.navigation/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer.navigation/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer.navigation/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer.theme/index.html b/latest/extensions/api/modules/renderer.theme/index.html index 849bf24ea3..bfc0ecb811 100644 --- a/latest/extensions/api/modules/renderer.theme/index.html +++ b/latest/extensions/api/modules/renderer.theme/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer.theme/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer.theme/... \ No newline at end of file diff --git a/latest/extensions/api/modules/renderer/index.html b/latest/extensions/api/modules/renderer/index.html index 0630eea862..e7f3b50e4d 100644 --- a/latest/extensions/api/modules/renderer/index.html +++ b/latest/extensions/api/modules/renderer/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v5.2.5/extensions/api/modules/renderer/... + Redirecting to ../../../../../v5.2.6/extensions/api/modules/renderer/... \ 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 9f6f464c92..43f1db4a2a 100644 --- a/latest/extensions/capabilities/common-capabilities/index.html +++ b/latest/extensions/capabilities/common-capabilities/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/capabilities/common-capabilities/... + Redirecting to ../../../../v5.2.6/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 8af4ef9d0c..efa2800a2b 100644 --- a/latest/extensions/capabilities/index.html +++ b/latest/extensions/capabilities/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v5.2.5/extensions/capabilities/... + Redirecting to ../../../v5.2.6/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 12c410220d..ad684e2f11 100644 --- a/latest/extensions/capabilities/styling/index.html +++ b/latest/extensions/capabilities/styling/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/capabilities/styling/... + Redirecting to ../../../../v5.2.6/extensions/capabilities/styling/... \ No newline at end of file diff --git a/latest/extensions/extension-migration/index.html b/latest/extensions/extension-migration/index.html index d3bfd07d22..cdb5e2c722 100644 --- a/latest/extensions/extension-migration/index.html +++ b/latest/extensions/extension-migration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v5.2.5/extensions/extension-migration/... + Redirecting to ../../../v5.2.6/extensions/extension-migration/... \ 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 142508e003..2f3096f4a2 100644 --- a/latest/extensions/get-started/anatomy/index.html +++ b/latest/extensions/get-started/anatomy/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/get-started/anatomy/... + Redirecting to ../../../../v5.2.6/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 5c557baf95..ddf6b949fb 100644 --- a/latest/extensions/get-started/overview/index.html +++ b/latest/extensions/get-started/overview/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/get-started/overview/... + Redirecting to ../../../../v5.2.6/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 99f0c7dbc5..fa6e0e8475 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 ../../../../v5.2.5/extensions/get-started/wrapping-up/... + Redirecting to ../../../../v5.2.6/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 017ef3309b..2e138bf575 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 ../../../../v5.2.5/extensions/get-started/your-first-extension/... + Redirecting to ../../../../v5.2.6/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 4d1532f28d..e8b0c9ccdd 100644 --- a/latest/extensions/guides/anatomy/index.html +++ b/latest/extensions/guides/anatomy/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/anatomy/... + Redirecting to ../../../../v5.2.6/extensions/guides/anatomy/... \ No newline at end of file diff --git a/latest/extensions/guides/catalog/index.html b/latest/extensions/guides/catalog/index.html index f5bcc6b631..7c35da9bbe 100644 --- a/latest/extensions/guides/catalog/index.html +++ b/latest/extensions/guides/catalog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/catalog/... + Redirecting to ../../../../v5.2.6/extensions/guides/catalog/... \ No newline at end of file diff --git a/latest/extensions/guides/components/index.html b/latest/extensions/guides/components/index.html index e2c6bc748a..1f00dcbf48 100644 --- a/latest/extensions/guides/components/index.html +++ b/latest/extensions/guides/components/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/components/... + Redirecting to ../../../../v5.2.6/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 7df54a07e0..fa218726e6 100644 --- a/latest/extensions/guides/generator/index.html +++ b/latest/extensions/guides/generator/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/generator/... + Redirecting to ../../../../v5.2.6/extensions/guides/generator/... \ No newline at end of file diff --git a/latest/extensions/guides/index.html b/latest/extensions/guides/index.html index f05cb65195..e8200a3097 100644 --- a/latest/extensions/guides/index.html +++ b/latest/extensions/guides/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v5.2.5/extensions/guides/... + Redirecting to ../../../v5.2.6/extensions/guides/... \ No newline at end of file diff --git a/latest/extensions/guides/ipc/index.html b/latest/extensions/guides/ipc/index.html index 33dba3bff3..16ac180f31 100644 --- a/latest/extensions/guides/ipc/index.html +++ b/latest/extensions/guides/ipc/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/ipc/... + Redirecting to ../../../../v5.2.6/extensions/guides/ipc/... \ 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 ee7d1d1fcd..9bd86ca99d 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 ../../../../v5.2.5/extensions/guides/kube-object-list-layout/... + Redirecting to ../../../../v5.2.6/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 4c4c90bf11..7bb605d5d2 100644 --- a/latest/extensions/guides/main-extension/index.html +++ b/latest/extensions/guides/main-extension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/main-extension/... + Redirecting to ../../../../v5.2.6/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 f89f307bb9..156a94ba53 100644 --- a/latest/extensions/guides/protocol-handlers/index.html +++ b/latest/extensions/guides/protocol-handlers/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/protocol-handlers/... + Redirecting to ../../../../v5.2.6/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 213e6d1035..7d91146d32 100644 --- a/latest/extensions/guides/renderer-extension/index.html +++ b/latest/extensions/guides/renderer-extension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/renderer-extension/... + Redirecting to ../../../../v5.2.6/extensions/guides/renderer-extension/... \ No newline at end of file diff --git a/latest/extensions/guides/resource-stack/index.html b/latest/extensions/guides/resource-stack/index.html index 8524331de1..8dcbb3d60a 100644 --- a/latest/extensions/guides/resource-stack/index.html +++ b/latest/extensions/guides/resource-stack/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/resource-stack/... + Redirecting to ../../../../v5.2.6/extensions/guides/resource-stack/... \ No newline at end of file diff --git a/latest/extensions/guides/stores/index.html b/latest/extensions/guides/stores/index.html index 05472e78ea..06d9f40d21 100644 --- a/latest/extensions/guides/stores/index.html +++ b/latest/extensions/guides/stores/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v5.2.5/extensions/guides/stores/... + Redirecting to ../../../../v5.2.6/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 0278627725..1b8baee0a0 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 ../../../../v5.2.5/extensions/guides/working-with-mobx/... + Redirecting to ../../../../v5.2.6/extensions/guides/working-with-mobx/... \ 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 fff2092b93..e3af690acf 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 ../../../../v5.2.5/extensions/testing-and-publishing/bundling/... + Redirecting to ../../../../v5.2.6/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 f56dec84f5..776a3982c0 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 ../../../../v5.2.5/extensions/testing-and-publishing/publishing/... + Redirecting to ../../../../v5.2.6/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 b5327c5905..983caf5a7a 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 ../../../../v5.2.5/extensions/testing-and-publishing/testing/... + Redirecting to ../../../../v5.2.6/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 1bd92cf415..b5b50b10dc 100644 --- a/latest/extensions/usage/index.html +++ b/latest/extensions/usage/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v5.2.5/extensions/usage/... + Redirecting to ../../../v5.2.6/extensions/usage/... \ No newline at end of file diff --git a/latest/index.html b/latest/index.html index 44260078b8..19a741c635 100644 --- a/latest/index.html +++ b/latest/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../v5.2.5/... + Redirecting to ../v5.2.6/... \ No newline at end of file diff --git a/v5.2.6/404.html b/v5.2.6/404.html new file mode 100644 index 0000000000..4adab08eec --- /dev/null +++ b/v5.2.6/404.html @@ -0,0 +1,747 @@ + + + + + + + + + + + + + + + + + + + + + + + + Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ +

404 - Not found

+ + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/CNAME b/v5.2.6/CNAME new file mode 100644 index 0000000000..f51f3799f9 --- /dev/null +++ b/v5.2.6/CNAME @@ -0,0 +1 @@ +api-docs.k8slens.dev diff --git a/v5.2.6/assets/images/favicon.png b/v5.2.6/assets/images/favicon.png new file mode 100644 index 0000000000..1cf13b9f9d Binary files /dev/null and b/v5.2.6/assets/images/favicon.png differ diff --git a/v5.2.6/assets/javascripts/bundle.82217815.min.js b/v5.2.6/assets/javascripts/bundle.82217815.min.js new file mode 100644 index 0000000000..f79dc267e1 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.ar.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.ar.min.js new file mode 100644 index 0000000000..248ddc5d14 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.de.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.de.min.js new file mode 100644 index 0000000000..f3b5c108c9 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.du.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.du.min.js new file mode 100644 index 0000000000..49a0f3f0ac --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.es.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.es.min.js new file mode 100644 index 0000000000..2989d34265 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.fi.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.fi.min.js new file mode 100644 index 0000000000..29f5dfcea8 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.fr.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.fr.min.js new file mode 100644 index 0000000000..68cd0094ae --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.hu.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.hu.min.js new file mode 100644 index 0000000000..ed9d909f73 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.it.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.it.min.js new file mode 100644 index 0000000000..344b6a3c0c --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.ja.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.ja.min.js new file mode 100644 index 0000000000..5f254ebe91 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.no.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.no.min.js new file mode 100644 index 0000000000..92bc7e4e89 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.pt.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.pt.min.js new file mode 100644 index 0000000000..6c16996d65 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.ro.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.ro.min.js new file mode 100644 index 0000000000..7277140181 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.ru.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.ru.min.js new file mode 100644 index 0000000000..186cc485c2 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.sv.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.sv.min.js new file mode 100644 index 0000000000..3e5eb64000 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.tr.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.tr.min.js new file mode 100644 index 0000000000..563f6ec1f5 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/min/lunr.vi.min.js b/v5.2.6/assets/javascripts/lunr/min/lunr.vi.min.js new file mode 100644 index 0000000000..22aed28c49 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/lunr/tinyseg.js b/v5.2.6/assets/javascripts/lunr/tinyseg.js new file mode 100644 index 0000000000..167fa6dd69 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/javascripts/workers/search.df8cae7d.min.js b/v5.2.6/assets/javascripts/workers/search.df8cae7d.min.js new file mode 100644 index 0000000000..4197eccca3 --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/stylesheets/main.92048cb8.min.css b/v5.2.6/assets/stylesheets/main.92048cb8.min.css new file mode 100644 index 0000000000..d4d59a00ef --- /dev/null +++ b/v5.2.6/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/v5.2.6/assets/stylesheets/palette.73e53a79.min.css b/v5.2.6/assets/stylesheets/palette.73e53a79.min.css new file mode 100644 index 0000000000..03a02114b5 --- /dev/null +++ b/v5.2.6/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/v5.2.6/custom_theme/img/favicon.ico b/v5.2.6/custom_theme/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v5.2.6/custom_theme/img/favicon.ico differ diff --git a/v5.2.6/custom_theme/main.html b/v5.2.6/custom_theme/main.html new file mode 100644 index 0000000000..94d9808cc7 --- /dev/null +++ b/v5.2.6/custom_theme/main.html @@ -0,0 +1 @@ +{% extends "base.html" %} diff --git a/v5.2.6/extensions/api/classes/common.catalog.catalogcategory/index.html b/v5.2.6/extensions/api/classes/common.catalog.catalogcategory/index.html new file mode 100644 index 0000000000..42584f354f --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.catalogcategory/index.html @@ -0,0 +1,1654 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CatalogCategory - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CatalogCategory#

+

Common.Catalog.CatalogCategory

+

Hierarchy#

+ +

↳ CatalogCategory

+

↳↳ GeneralCategory

+

↳↳ WebLinkCategory

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CatalogCategory()

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).constructor

+

Properties#

+

apiVersion#

+

• Readonly Abstract apiVersion: string

+
+

kind#

+

• Readonly Abstract kind: string

+
+

metadata#

+

• Abstract metadata: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
iconstring
namestring
+
+

spec#

+

• Abstract spec: CatalogCategorySpec

+

Methods#

+

addListener#

+

▸ addListener<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).addListener

+
+

emit#

+

▸ emit<E>(event, ...args): boolean

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
...argsArguments<CatalogCategoryEvents[E]>
+

Returns#

+

boolean

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).emit

+
+

eventNames#

+

▸ eventNames(): (string | symbol)[]

+

Returns#

+

(string | symbol)[]

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).eventNames

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+
+

getMaxListeners#

+

▸ getMaxListeners(): number

+

Returns#

+

number

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).getMaxListeners

+
+

listenerCount#

+

▸ listenerCount<E>(event): number

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

number

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).listenerCount

+
+

listeners#

+

▸ listeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).listeners

+
+

off#

+

▸ off<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).off

+
+

on#

+

▸ on<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).on

+
+

once#

+

▸ once<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).once

+
+

prependListener#

+

▸ prependListener<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).prependListener

+
+

prependOnceListener#

+

▸ prependOnceListener<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).prependOnceListener

+
+

rawListeners#

+

▸ rawListeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).rawListeners

+
+

removeAllListeners#

+

▸ removeAllListeners<E>(event?): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
event?E
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).removeAllListeners

+
+

removeListener#

+

▸ removeListener<E>(event, listener): CatalogCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).removeListener

+
+

setMaxListeners#

+

▸ setMaxListeners(maxListeners): CatalogCategory

+

Parameters#

+ + + + + + + + + + + + + +
NameType
maxListenersnumber
+

Returns#

+

CatalogCategory

+

Inherited from#

+

(EventEmitter as new () => TypedEmitter<CatalogCategoryEvents>).setMaxListeners

+
+

parseId#

+

▸ Static parseId(id?): Object

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
idstring""
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
group?string
kind?string
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.catalogentity/index.html b/v5.2.6/extensions/api/classes/common.catalog.catalogentity/index.html new file mode 100644 index 0000000000..b492a9503f --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.catalogentity/index.html @@ -0,0 +1,1144 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CatalogEntity - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CatalogEntity<Metadata, Status, Spec>#

+

Common.Catalog.CatalogEntity

+

Type parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
MetadataMetadata: CatalogEntityMetadata = CatalogEntityMetadata
StatusStatus: CatalogEntityStatus = CatalogEntityStatus
SpecSpec: CatalogEntitySpec = CatalogEntitySpec
+

Hierarchy#

+
    +
  • CatalogEntity
    • +
+

↳ GeneralEntity

+

↳ KubernetesCluster

+

↳ WebLink

+

Implements#

+ +

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CatalogEntity<Metadata, Status, Spec>(data)

+

Type parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
MetadataMetadata: CatalogEntityMetadata = CatalogEntityMetadata
StatusStatus: CatalogEntityStatus = CatalogEntityStatus
SpecSpec: CatalogEntitySpec = CatalogEntitySpec
+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataCatalogEntityData<Metadata, Status, Spec>
+

Properties#

+

apiVersion#

+

• Readonly Abstract apiVersion: string

+

Implementation of#

+

CatalogEntityKindData.apiVersion

+
+

kind#

+

• Readonly Abstract kind: string

+

Implementation of#

+

CatalogEntityKindData.kind

+
+

metadata#

+

• metadata: Metadata

+
+

spec#

+

• spec: Spec

+
+

status#

+

• status: Status

+

Methods#

+

getId#

+

▸ getId(): string

+

Returns#

+

string

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+
+

onContextMenuOpen#

+

▸ Abstract onContextMenuOpen(context): void | Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntityContextMenuContext
+

Returns#

+

void | Promise<void>

+
+

onRun#

+

▸ Optional Abstract onRun(context): void | Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntityActionContext
+

Returns#

+

void | Promise<void>

+
+

onSettingsOpen#

+

▸ Abstract onSettingsOpen(context): void | Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntitySettingsContext
+

Returns#

+

void | Promise<void>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.generalcategory/index.html b/v5.2.6/extensions/api/classes/common.catalog.generalcategory/index.html new file mode 100644 index 0000000000..1f39fb9357 --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.generalcategory/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: GeneralCategory - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: GeneralCategory#

+

Common.Catalog.GeneralCategory

+

Hierarchy#

+ +

↳ GeneralCategory

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new GeneralCategory()

+

Inherited from#

+

CatalogCategory.constructor

+

Properties#

+

apiVersion#

+

• Readonly apiVersion: "catalog.k8slens.dev/v1alpha1"

+

Overrides#

+

CatalogCategory.apiVersion

+
+

kind#

+

• Readonly kind: "CatalogCategory"

+

Overrides#

+

CatalogCategory.kind

+
+

metadata#

+

• metadata: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
iconstring
namestring
+

Overrides#

+

CatalogCategory.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
groupstring
namesObject
names.kindstring
versions{ entityClass: typeof GeneralEntity ; name: string = "v1alpha1" }[]
+

Overrides#

+

CatalogCategory.spec

+

Methods#

+

addListener#

+

▸ addListener<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.addListener

+
+

emit#

+

▸ emit<E>(event, ...args): boolean

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
...argsArguments<CatalogCategoryEvents[E]>
+

Returns#

+

boolean

+

Inherited from#

+

CatalogCategory.emit

+
+

eventNames#

+

▸ eventNames(): (string | symbol)[]

+

Returns#

+

(string | symbol)[]

+

Inherited from#

+

CatalogCategory.eventNames

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogCategory.getId

+
+

getMaxListeners#

+

▸ getMaxListeners(): number

+

Returns#

+

number

+

Inherited from#

+

CatalogCategory.getMaxListeners

+
+

listenerCount#

+

▸ listenerCount<E>(event): number

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

number

+

Inherited from#

+

CatalogCategory.listenerCount

+
+

listeners#

+

▸ listeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

CatalogCategory.listeners

+
+

off#

+

▸ off<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.off

+
+

on#

+

▸ on<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.on

+
+

once#

+

▸ once<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.once

+
+

prependListener#

+

▸ prependListener<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.prependListener

+
+

prependOnceListener#

+

▸ prependOnceListener<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.prependOnceListener

+
+

rawListeners#

+

▸ rawListeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

CatalogCategory.rawListeners

+
+

removeAllListeners#

+

▸ removeAllListeners<E>(event?): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
event?E
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.removeAllListeners

+
+

removeListener#

+

▸ removeListener<E>(event, listener): GeneralCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.removeListener

+
+

setMaxListeners#

+

▸ setMaxListeners(maxListeners): GeneralCategory

+

Parameters#

+ + + + + + + + + + + + + +
NameType
maxListenersnumber
+

Returns#

+

GeneralCategory

+

Inherited from#

+

CatalogCategory.setMaxListeners

+
+

parseId#

+

▸ Static parseId(id?): Object

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
idstring""
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
group?string
kind?string
+

Inherited from#

+

CatalogCategory.parseId

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.generalentity/index.html b/v5.2.6/extensions/api/classes/common.catalog.generalentity/index.html new file mode 100644 index 0000000000..a1f033776d --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.generalentity/index.html @@ -0,0 +1,1064 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: GeneralEntity - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: GeneralEntity#

+

Common.Catalog.GeneralEntity

+

Hierarchy#

+ +

↳ GeneralEntity

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new GeneralEntity(data)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataCatalogEntityData<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>
+

Inherited from#

+

CatalogEntity.constructor

+

Properties#

+

apiVersion#

+

• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"

+

Overrides#

+

CatalogEntity.apiVersion

+
+

kind#

+

• Readonly kind: "General"

+

Overrides#

+

CatalogEntity.kind

+
+

metadata#

+

• metadata: CatalogEntityMetadata

+

Inherited from#

+

CatalogEntity.metadata

+
+

spec#

+

• spec: GeneralEntitySpec

+

Inherited from#

+

CatalogEntity.spec

+
+

status#

+

• status: CatalogEntityStatus

+

Inherited from#

+

CatalogEntity.status

+

Methods#

+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getId

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getName

+
+

onContextMenuOpen#

+

▸ onContextMenuOpen(): void

+

Returns#

+

void

+

Overrides#

+

CatalogEntity.onContextMenuOpen

+
+

onDetailsOpen#

+

▸ onDetailsOpen(): void

+

Returns#

+

void

+
+

onRun#

+

▸ onRun(): Promise<void>

+

Returns#

+

Promise<void>

+

Overrides#

+

CatalogEntity.onRun

+
+

onSettingsOpen#

+

▸ onSettingsOpen(): void

+

Returns#

+

void

+

Overrides#

+

CatalogEntity.onSettingsOpen

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.kubernetescluster/index.html b/v5.2.6/extensions/api/classes/common.catalog.kubernetescluster/index.html new file mode 100644 index 0000000000..54a9f755d6 --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.kubernetescluster/index.html @@ -0,0 +1,1142 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubernetesCluster - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubernetesCluster#

+

Common.Catalog.KubernetesCluster

+

Hierarchy#

+ +

↳ KubernetesCluster

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubernetesCluster(data)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataCatalogEntityData<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec>
+

Inherited from#

+

CatalogEntity.constructor

+

Properties#

+

apiVersion#

+

• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"

+

Overrides#

+

CatalogEntity.apiVersion

+
+

kind#

+

• Readonly kind: "KubernetesCluster"

+

Overrides#

+

CatalogEntity.kind

+
+

metadata#

+

• metadata: KubernetesClusterMetadata

+

Inherited from#

+

CatalogEntity.metadata

+
+

spec#

+

• spec: KubernetesClusterSpec

+

Inherited from#

+

CatalogEntity.spec

+
+

status#

+

• status: KubernetesClusterStatus

+

Inherited from#

+

CatalogEntity.status

+
+

apiVersion#

+

▪ Static Readonly apiVersion: "entity.k8slens.dev/v1alpha1"

+
+

kind#

+

▪ Static Readonly kind: "KubernetesCluster"

+

Methods#

+

connect#

+

▸ connect(): Promise<void>

+

Returns#

+

Promise<void>

+
+

disconnect#

+

▸ disconnect(): Promise<void>

+

Returns#

+

Promise<void>

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getId

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getName

+
+

onContextMenuOpen#

+

▸ onContextMenuOpen(context): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntityContextMenuContext
+

Returns#

+

Promise<void>

+

Overrides#

+

CatalogEntity.onContextMenuOpen

+
+

onDetailsOpen#

+

▸ onDetailsOpen(): void

+

Returns#

+

void

+
+

onRun#

+

▸ onRun(context): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntityActionContext
+

Returns#

+

Promise<void>

+

Overrides#

+

CatalogEntity.onRun

+
+

onSettingsOpen#

+

▸ onSettingsOpen(): void

+

Returns#

+

void

+

Overrides#

+

CatalogEntity.onSettingsOpen

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.weblink/index.html b/v5.2.6/extensions/api/classes/common.catalog.weblink/index.html new file mode 100644 index 0000000000..0c509f764c --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.weblink/index.html @@ -0,0 +1,1066 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: WebLink - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: WebLink#

+

Common.Catalog.WebLink

+

Hierarchy#

+ +

↳ WebLink

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new WebLink(data)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataCatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>
+

Inherited from#

+

CatalogEntity.constructor

+

Properties#

+

apiVersion#

+

• Readonly apiVersion: "entity.k8slens.dev/v1alpha1"

+

Overrides#

+

CatalogEntity.apiVersion

+
+

kind#

+

• Readonly kind: "WebLink"

+

Overrides#

+

CatalogEntity.kind

+
+

metadata#

+

• metadata: CatalogEntityMetadata

+

Inherited from#

+

CatalogEntity.metadata

+
+

spec#

+

• spec: WebLinkSpec

+

Inherited from#

+

CatalogEntity.spec

+
+

status#

+

• status: WebLinkStatus

+

Inherited from#

+

CatalogEntity.status

+

Methods#

+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getId

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogEntity.getName

+
+

onContextMenuOpen#

+

▸ onContextMenuOpen(context): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
contextCatalogEntityContextMenuContext
+

Returns#

+

Promise<void>

+

Overrides#

+

CatalogEntity.onContextMenuOpen

+
+

onRun#

+

▸ onRun(): Promise<void>

+

Returns#

+

Promise<void>

+

Overrides#

+

CatalogEntity.onRun

+
+

onSettingsOpen#

+

▸ onSettingsOpen(): void

+

Returns#

+

void

+

Overrides#

+

CatalogEntity.onSettingsOpen

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.catalog.weblinkcategory/index.html b/v5.2.6/extensions/api/classes/common.catalog.weblinkcategory/index.html new file mode 100644 index 0000000000..04c1516dd5 --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.catalog.weblinkcategory/index.html @@ -0,0 +1,1706 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: WebLinkCategory - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: WebLinkCategory#

+

Common.Catalog.WebLinkCategory

+

Hierarchy#

+ +

↳ WebLinkCategory

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new WebLinkCategory()

+

Overrides#

+

CatalogCategory.constructor

+

Properties#

+

apiVersion#

+

• Readonly apiVersion: "catalog.k8slens.dev/v1alpha1"

+

Overrides#

+

CatalogCategory.apiVersion

+
+

kind#

+

• Readonly kind: "CatalogCategory"

+

Overrides#

+

CatalogCategory.kind

+
+

metadata#

+

• metadata: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
iconstring
namestring
+

Overrides#

+

CatalogCategory.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
groupstring
namesObject
names.kindstring
versions{ entityClass: typeof WebLink ; name: string = "v1alpha1" }[]
+

Overrides#

+

CatalogCategory.spec

+
+

onAdd#

+

▪ Static Optional onAdd: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Methods#

+

addListener#

+

▸ addListener<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.addListener

+
+

emit#

+

▸ emit<E>(event, ...args): boolean

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
...argsArguments<CatalogCategoryEvents[E]>
+

Returns#

+

boolean

+

Inherited from#

+

CatalogCategory.emit

+
+

eventNames#

+

▸ eventNames(): (string | symbol)[]

+

Returns#

+

(string | symbol)[]

+

Inherited from#

+

CatalogCategory.eventNames

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

CatalogCategory.getId

+
+

getMaxListeners#

+

▸ getMaxListeners(): number

+

Returns#

+

number

+

Inherited from#

+

CatalogCategory.getMaxListeners

+
+

listenerCount#

+

▸ listenerCount<E>(event): number

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

number

+

Inherited from#

+

CatalogCategory.listenerCount

+
+

listeners#

+

▸ listeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

CatalogCategory.listeners

+
+

off#

+

▸ off<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.off

+
+

on#

+

▸ on<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.on

+
+

once#

+

▸ once<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.once

+
+

prependListener#

+

▸ prependListener<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.prependListener

+
+

prependOnceListener#

+

▸ prependOnceListener<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.prependOnceListener

+
+

rawListeners#

+

▸ rawListeners<E>(event): Function[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventE
+

Returns#

+

Function[]

+

Inherited from#

+

CatalogCategory.rawListeners

+
+

removeAllListeners#

+

▸ removeAllListeners<E>(event?): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + +
NameType
event?E
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.removeAllListeners

+
+

removeListener#

+

▸ removeListener<E>(event, listener): WebLinkCategory

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: keyof CatalogCategoryEvents
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
eventE
listenerCatalogCategoryEvents[E]
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.removeListener

+
+

setMaxListeners#

+

▸ setMaxListeners(maxListeners): WebLinkCategory

+

Parameters#

+ + + + + + + + + + + + + +
NameType
maxListenersnumber
+

Returns#

+

WebLinkCategory

+

Inherited from#

+

CatalogCategory.setMaxListeners

+
+

parseId#

+

▸ Static parseId(id?): Object

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
idstring""
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
group?string
kind?string
+

Inherited from#

+

CatalogCategory.parseId

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.store.extensionstore/index.html b/v5.2.6/extensions/api/classes/common.store.extensionstore/index.html new file mode 100644 index 0000000000..c451f88c76 --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.store.extensionstore/index.html @@ -0,0 +1,1519 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ExtensionStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ExtensionStore<T>#

+

Common.Store.ExtensionStore

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Hierarchy#

+
    +
  • BaseStore<T>
    • +
+

↳ ExtensionStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• Protected new ExtensionStore<T>(params)

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + +
NameType
paramsBaseStoreParams<T>
+

Inherited from#

+

BaseStore<T>.constructor

+

Properties#

+

extension#

+

• Protected extension: LensExtension

+
+

params#

+

• Protected params: BaseStoreParams<T>

+

Inherited from#

+

BaseStore.params

+
+

storeConfig#

+

• Protected Optional storeConfig: Conf<T>

+

Inherited from#

+

BaseStore.storeConfig

+
+

syncDisposers#

+

• Protected syncDisposers: Disposer[] = []

+

Inherited from#

+

BaseStore.syncDisposers

+

Accessors#

+

name#

+

• get name(): string

+

Returns#

+

string

+
+

path#

+

• get path(): string

+

Returns#

+

string

+
+

syncMainChannel#

+

• Protected get syncMainChannel(): string

+

Returns#

+

string

+
+

syncRendererChannel#

+

• Protected get syncRendererChannel(): string

+

Returns#

+

string

+

Methods#

+

applyWithoutSync#

+

▸ Protected applyWithoutSync(callback): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback() => void
+

Returns#

+

void

+

Inherited from#

+

BaseStore.applyWithoutSync

+
+

cwd#

+

▸ Protected cwd(): string

+

Returns#

+

string

+

Overrides#

+

BaseStore.cwd

+
+

disableSync#

+

▸ disableSync(): void

+

Returns#

+

void

+

Inherited from#

+

BaseStore.disableSync

+
+

enableSync#

+

▸ enableSync(): void

+

Returns#

+

void

+

Inherited from#

+

BaseStore.enableSync

+
+

fromStore#

+

▸ Protected Abstract fromStore(data): void

+

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

+

Note: This function must be synchronous.

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
dataTthe parsed information read from the stored JSON file
+

Returns#

+

void

+

Inherited from#

+

BaseStore.fromStore

+
+

load#

+

▸ load(): void

+

Returns#

+

void

+

Overrides#

+

BaseStore.load

+
+

loadExtension#

+

▸ loadExtension(extension): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
extensionLensExtension
+

Returns#

+

void

+
+

onModelChange#

+

▸ Protected onModelChange(model): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+

Inherited from#

+

BaseStore.onModelChange

+
+

onSync#

+

▸ Protected onSync(model): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

BaseStore.onSync

+
+

onSyncFromMain#

+

▸ Protected onSyncFromMain(model): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

BaseStore.onSyncFromMain

+
+

saveToFile#

+

▸ Protected saveToFile(model): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+

Inherited from#

+

BaseStore.saveToFile

+
+

toJSON#

+

▸ Abstract toJSON(): T

+

toJSON is called when syncing the store to the filesystem. It should +produce a JSON serializable object representation 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

+

Inherited from#

+

BaseStore.toJSON

+
+

unregisterIpcListener#

+

▸ unregisterIpcListener(): void

+

Returns#

+

void

+

Inherited from#

+

BaseStore.unregisterIpcListener

+
+

createInstance#

+

▸ Static createInstance<T, R>(...args): T

+

Creates the single instance of the child class if one was not already created.

+

Multiple calls will return the same instance. +Essentially throwing away the arguments to the subsequent calls.

+

Note: this is a racy function, if two (or more) calls are racing to call this function +only the first's arguments will be used.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
...argsRThe constructor arguments for the child class
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

BaseStore.createInstance

+
+

getInstance#

+

▸ Static getInstance<T, R>(strict): T

+

Get the instance of the child class that was previously created.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
strictbooleanIf false will return undefined instead of throwing when an instance doesn't exist. Default: true
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

BaseStore.getInstance

+
+

resetInstance#

+

▸ Static resetInstance(): void

+

Delete the instance of the child class.

+

Note: this doesn't prevent callers of getInstance from storing the result in a global.

+

There is no way in JS or TS to prevent globals like that.

+

Returns#

+

void

+

Inherited from#

+

BaseStore.resetInstance

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/common.util.singleton/index.html b/v5.2.6/extensions/api/classes/common.util.singleton/index.html new file mode 100644 index 0000000000..5edcfd1549 --- /dev/null +++ b/v5.2.6/extensions/api/classes/common.util.singleton/index.html @@ -0,0 +1,1008 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Singleton - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Singleton#

+

Common.Util.Singleton

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Hierarchy#

+
    +
  • Singleton
    • +
+

↳ TerminalStore

+

Table of contents#

+

Constructors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Singleton()

+

Methods#

+

createInstance#

+

▸ Static createInstance<T, R>(...args): T

+

Creates the single instance of the child class if one was not already created.

+

Multiple calls will return the same instance. +Essentially throwing away the arguments to the subsequent calls.

+

Note: this is a racy function, if two (or more) calls are racing to call this function +only the first's arguments will be used.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
...argsRThe constructor arguments for the child class
+

Returns#

+

T

+

An instance of the child class

+
+

getInstance#

+

▸ Static getInstance<T, R>(strict): T

+

Get the instance of the child class that was previously created.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
strictbooleanIf false will return undefined instead of throwing when an instance doesn't exist. Default: true
+

Returns#

+

T

+

An instance of the child class

+
+

resetInstance#

+

▸ Static resetInstance(): void

+

Delete the instance of the child class.

+

Note: this doesn't prevent callers of getInstance from storing the result in a global.

+

There is no way in JS or TS to prevent globals like that.

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/main.catalog.catalogentityregistry/index.html b/v5.2.6/extensions/api/classes/main.catalog.catalogentityregistry/index.html new file mode 100644 index 0000000000..1fe1dcf3b8 --- /dev/null +++ b/v5.2.6/extensions/api/classes/main.catalog.catalogentityregistry/index.html @@ -0,0 +1,906 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CatalogEntityRegistry - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CatalogEntityRegistry#

+

Main.Catalog.CatalogEntityRegistry

+

Table of contents#

+

Constructors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CatalogEntityRegistry()

+

Methods#

+

getItemsForApiKind#

+

▸ getItemsForApiKind<T>(apiVersion, kind): T[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
apiVersionstring
kindstring
+

Returns#

+

T[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/main.ipc/index.html b/v5.2.6/extensions/api/classes/main.ipc/index.html new file mode 100644 index 0000000000..343f161829 --- /dev/null +++ b/v5.2.6/extensions/api/classes/main.ipc/index.html @@ -0,0 +1,1175 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Ipc - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Ipc#

+

Main.Ipc

+

Hierarchy#

+
    +
  • IpcRegistrar
    • +
+

↳ Ipc

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Ipc(extension)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
extensionLensExtension
+

Overrides#

+

IpcRegistrar.constructor

+

Properties#

+

[IpcPrefix]#

+

• Readonly [IpcPrefix]: string

+

Inherited from#

+

IpcRegistrar.__@IpcPrefix@43866

+
+

extension#

+

• Protected extension: LensExtension

+

Inherited from#

+

IpcRegistrar.extension

+

Methods#

+

broadcast#

+

▸ broadcast(channel, ...args): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe channel to broadcast to your whole extension, both main and renderer
...argsany[]The arguments passed to all listeners
+

Returns#

+

void

+

Inherited from#

+

IpcRegistrar.broadcast

+
+

handle#

+

▸ handle(channel, handler): void

+

Declare a RPC over channel. Lens will cleanup when the extension is disabled or uninstalled

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe name of the RPC
handler(event: IpcMainInvokeEvent, ...args: any[]) => anyThe remote procedure that is called
+

Returns#

+

void

+
+

listen#

+

▸ listen(channel, listener): Disposer

+

Listen for broadcasts within your extension

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe channel to listen for broadcasts on
listener(event: IpcRendererEvent, ...args: any[]) => anyThe function that will be called with the arguments of the broadcast
+

Returns#

+

Disposer

+

An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called

+
+

createInstance#

+

▸ Static createInstance<T, R>(...args): T

+

Creates the single instance of the child class if one was not already created.

+

Multiple calls will return the same instance. +Essentially throwing away the arguments to the subsequent calls.

+

Note: this is a racy function, if two (or more) calls are racing to call this function +only the first's arguments will be used.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
...argsRThe constructor arguments for the child class
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

IpcRegistrar.createInstance

+
+

getInstance#

+

▸ Static getInstance<T, R>(strict): T

+

Get the instance of the child class that was previously created.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
strictbooleanIf false will return undefined instead of throwing when an instance doesn't exist. Default: true
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

IpcRegistrar.getInstance

+
+

resetInstance#

+

▸ Static resetInstance(): void

+

Delete the instance of the child class.

+

Note: this doesn't prevent callers of getInstance from storing the result in a global.

+

There is no way in JS or TS to prevent globals like that.

+

Returns#

+

void

+

Inherited from#

+

IpcRegistrar.resetInstance

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/main.lensextension/index.html b/v5.2.6/extensions/api/classes/main.lensextension/index.html new file mode 100644 index 0000000000..2c8a271bfe --- /dev/null +++ b/v5.2.6/extensions/api/classes/main.lensextension/index.html @@ -0,0 +1,1252 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LensExtension - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LensExtension#

+

Main.LensExtension

+

Hierarchy#

+
    +
  • LensExtension
    • +
+

↳ LensExtension

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new LensExtension(__namedParameters)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersInstalledExtension
+

Inherited from#

+

LensExtension.constructor

+

Properties#

+

[Disposers]#

+

• [Disposers]: ExtendableDisposer

+

Inherited from#

+

LensExtension.__@Disposers@24661

+
+

appMenus#

+

• appMenus: MenuRegistration[] = []

+
+

id#

+

• Readonly id: string

+

Inherited from#

+

LensExtension.id

+
+

isBundled#

+

• Readonly isBundled: boolean

+

Inherited from#

+

LensExtension.isBundled

+
+

manifest#

+

• Readonly manifest: LensExtensionManifest

+

Inherited from#

+

LensExtension.manifest

+
+

manifestPath#

+

• Readonly manifestPath: string

+

Inherited from#

+

LensExtension.manifestPath

+
+

protocolHandlers#

+

• protocolHandlers: ProtocolHandlerRegistration[] = []

+

Inherited from#

+

LensExtension.protocolHandlers

+

Accessors#

+

description#

+

• get description(): string

+

Returns#

+

string

+
+

name#

+

• get name(): string

+

Returns#

+

string

+
+

version#

+

• get version(): string

+

Returns#

+

string

+

Methods#

+

addCatalogSource#

+

▸ addCatalogSource(id, source): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
idstring
sourceIObservableArray<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>
+

Returns#

+

void

+
+

disable#

+

▸ disable(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

LensExtension.disable

+
+

enable#

+

▸ enable(register): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
register(ext: LensExtension) => Promise<Disposer[]>
+

Returns#

+

Promise<void>

+

Inherited from#

+

LensExtension.enable

+
+

getExtensionFileFolder#

+

▸ getExtensionFileFolder(): Promise<string>

+

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 obfuscation of the +folder name.

+

Returns#

+

Promise<string>

+

Inherited from#

+

LensExtension.getExtensionFileFolder

+
+ +

▸ navigate(pageId?, params?, frameId?): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
pageId?string
params?Record<string, any>
frameId?number
+

Returns#

+

Promise<void>

+
+

onActivate#

+

▸ Protected onActivate(): void | Promise<void>

+

Returns#

+

void | Promise<void>

+

Inherited from#

+

LensExtension.onActivate

+
+

onDeactivate#

+

▸ Protected onDeactivate(): void | Promise<void>

+

Returns#

+

void | Promise<void>

+

Inherited from#

+

LensExtension.onDeactivate

+
+

removeCatalogSource#

+

▸ removeCatalogSource(id): void

+

Parameters#

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

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html b/v5.2.6/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html new file mode 100644 index 0000000000..09a3364708 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.catalog.catalogentityregistry/index.html @@ -0,0 +1,1027 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CatalogEntityRegistry - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CatalogEntityRegistry#

+

Renderer.Catalog.CatalogEntityRegistry

+

Table of contents#

+

Constructors#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CatalogEntityRegistry()

+

Accessors#

+

activeEntity#

+

• get activeEntity(): CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

+

Currently active/visible entity

+

Returns#

+

CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

+
+

entities#

+

• get entities(): Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

+

Returns#

+

Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>

+

Methods#

+

getById#

+

▸ getById(id): CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

+

Parameters#

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

Returns#

+

CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

+
+

getItemsForApiKind#

+

▸ getItemsForApiKind<T>(apiVersion, kind): T[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
apiVersionstring
kindstring
+

Returns#

+

T[]

+
+

getItemsForCategory#

+

▸ getItemsForCategory<T>(category): T[]

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
categoryCatalogCategory
+

Returns#

+

T[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.badge/index.html b/v5.2.6/extensions/api/classes/renderer.component.badge/index.html new file mode 100644 index 0000000000..37063e86de --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.badge/index.html @@ -0,0 +1,1649 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Badge - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Badge#

+

Renderer.Component.Badge

+

Hierarchy#

+ +

↳ Badge

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Badge(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsBadgeProps
+

Overrides#

+

React.Component<BadgeProps\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

elem#

+

• elem: HTMLElement

+
+

isExpanded#

+

• isExpanded: boolean = false

+
+

props#

+

• Readonly props: Readonly<BadgeProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

badgeMeta#

+

▪ Static badgeMeta: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
hasTextSelectedboolean
+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: Partial<BadgeProps>

+

Accessors#

+

isExpandable#

+

• get isExpandable(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

bindRef#

+

▸ bindRef(elem): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
elemHTMLElement
+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onMouseUp#

+

▸ onMouseUp(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<BadgeProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.barchart/index.html b/v5.2.6/extensions/api/classes/renderer.component.barchart/index.html new file mode 100644 index 0000000000..23c1aef5f5 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.barchart/index.html @@ -0,0 +1,1548 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: BarChart - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: BarChart#

+

Renderer.Component.BarChart

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ BarChart

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new BarChart(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new BarChart(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.button/index.html b/v5.2.6/extensions/api/classes/renderer.component.button/index.html new file mode 100644 index 0000000000..a15a5e771a --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.button/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Button - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Button#

+

Renderer.Component.Button

+

Hierarchy#

+ +

↳ Button

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Button(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsButtonProps | Readonly<ButtonProps>
+

Inherited from#

+

React.PureComponent<ButtonProps, {}>.constructor

+

• new Button(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsButtonProps
contextany
+

Inherited from#

+

React.PureComponent<ButtonProps, {}>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<ButtonProps> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<ButtonProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.checkbox/index.html b/v5.2.6/extensions/api/classes/renderer.component.checkbox/index.html new file mode 100644 index 0000000000..0ee59471fe --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.checkbox/index.html @@ -0,0 +1,1578 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Checkbox - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Checkbox#

+

Renderer.Component.Checkbox

+

Hierarchy#

+ +

↳ Checkbox

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Checkbox(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsCheckboxProps<boolean> | Readonly<CheckboxProps<boolean>>
+

Inherited from#

+

React.PureComponent<CheckboxProps>.constructor

+

• new Checkbox(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsCheckboxProps<boolean>
contextany
+

Inherited from#

+

React.PureComponent<CheckboxProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<CheckboxProps<boolean>> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<boolean>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<boolean>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<boolean>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<boolean>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<boolean>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<boolean>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

getValue#

+

▸ getValue(): boolean

+

Returns#

+

boolean

+
+

onChange#

+

▸ onChange(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtChangeEvent<HTMLInputElement>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<CheckboxProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<boolean>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.commandoverlay/index.html b/v5.2.6/extensions/api/classes/renderer.component.commandoverlay/index.html new file mode 100644 index 0000000000..fdcd5dfb4b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.commandoverlay/index.html @@ -0,0 +1,949 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CommandOverlay - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CommandOverlay#

+

Renderer.Component.CommandOverlay

+

Table of contents#

+

Constructors#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CommandOverlay()

+

Accessors#

+

component#

+

• Static get component(): ReactElement<any, string | JSXElementConstructor<any>>

+

Returns#

+

ReactElement<any, string | JSXElementConstructor<any>>

+
+

isOpen#

+

• Static get isOpen(): boolean

+

Returns#

+

boolean

+

Methods#

+

close#

+

▸ Static close(): void

+

Returns#

+

void

+
+

open#

+

▸ Static open(component): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
componentReactElement<any, string | JSXElementConstructor<any>>
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.confirmdialog/index.html b/v5.2.6/extensions/api/classes/renderer.component.confirmdialog/index.html new file mode 100644 index 0000000000..cfe27e6684 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.confirmdialog/index.html @@ -0,0 +1,1666 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ConfirmDialog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ConfirmDialog#

+

Renderer.Component.ConfirmDialog

+

Hierarchy#

+ +

↳ ConfirmDialog

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ConfirmDialog(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsConfirmDialogProps
+

Overrides#

+

React.Component<ConfirmDialogProps\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

isSaving#

+

• isSaving: boolean = false

+
+

props#

+

• Readonly props: Readonly<ConfirmDialogProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultParams#

+

▪ Static defaultParams: Partial<ConfirmDialogParams>

+

Accessors#

+

params#

+

• get params(): ConfirmDialogParams

+

Returns#

+

ConfirmDialogParams

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

close#

+

▸ close(): Promise<void>

+

Returns#

+

Promise<void>

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

ok#

+

▸ ok(): Promise<void>

+

Returns#

+

Promise<void>

+
+

onClose#

+

▸ onClose(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<ConfirmDialogProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

confirm#

+

▸ Static confirm(params): Promise<boolean>

+

Parameters#

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

Returns#

+

Promise<boolean>

+
+

open#

+

▸ Static open(params): void

+

Parameters#

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

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.dialog/index.html b/v5.2.6/extensions/api/classes/renderer.component.dialog/index.html new file mode 100644 index 0000000000..e842251cba --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.dialog/index.html @@ -0,0 +1,1731 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Dialog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Dialog#

+

Renderer.Component.Dialog

+

Hierarchy#

+ +

↳ Dialog

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Dialog(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDialogProps | Readonly<DialogProps>
+

Inherited from#

+

React.PureComponent<DialogProps, DialogState>.constructor

+

• new Dialog(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsDialogProps
contextany
+

Inherited from#

+

React.PureComponent<DialogProps, DialogState>.constructor

+

Properties#

+

closeOnNavigate#

+

• closeOnNavigate: IReactionDisposer

+
+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<DialogProps> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: DialogState

+

Overrides#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+
+

defaultProps#

+

▪ Static defaultProps: DialogProps

+

Accessors#

+

elem#

+

• get elem(): HTMLElement

+

Returns#

+

HTMLElement

+
+

isOpen#

+

• get isOpen(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

close#

+

▸ close(): void

+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ componentDidUpdate(prevProps): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
prevPropsDialogProps
+

Returns#

+

void

+

Overrides#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

onClickOutside#

+

▸ onClickOutside(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onClose#

+

▸ onClose(): void

+

Returns#

+

void

+
+

onEscapeKey#

+

▸ onEscapeKey(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onOpen#

+

▸ onOpen(): void

+

Returns#

+

void

+
+

open#

+

▸ open(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): ReactPortal

+

Returns#

+

ReactPortal

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: "isOpen"
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateDialogState | (prevState: Readonly<DialogState>, props: Readonly<DialogProps>) => DialogState | Pick<DialogState, K> | Pick<DialogState, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+
+

toggle#

+

▸ toggle(isOpen): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
isOpenboolean
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.drawer/index.html b/v5.2.6/extensions/api/classes/renderer.component.drawer/index.html new file mode 100644 index 0000000000..ddf7b9a4c1 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.drawer/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Drawer - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Drawer#

+

Renderer.Component.Drawer

+

Hierarchy#

+ +

↳ Drawer

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Drawer(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDrawerProps | Readonly<DrawerProps>
+

Inherited from#

+

React.Component<DrawerProps>.constructor

+

• new Drawer(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsDrawerProps
contextany
+

Inherited from#

+

React.Component<DrawerProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<DrawerProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: State

+

Overrides#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

close#

+

▸ close(): void

+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

copyK8sObjName#

+

▸ copyK8sObjName(): void

+

Returns#

+

void

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onClickOutside#

+

▸ onClickOutside(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onEscapeKey#

+

▸ onEscapeKey(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onMouseDown#

+

▸ onMouseDown(evt): void

+

Parameters#

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

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

restoreScrollPos#

+

▸ restoreScrollPos(): void

+

Returns#

+

void

+
+

saveScrollPos#

+

▸ saveScrollPos(): void

+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<DrawerProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.draweritem/index.html b/v5.2.6/extensions/api/classes/renderer.component.draweritem/index.html new file mode 100644 index 0000000000..efe4747da3 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.draweritem/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DrawerItem - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DrawerItem#

+

Renderer.Component.DrawerItem

+

Hierarchy#

+ +

↳ DrawerItem

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DrawerItem(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDrawerItemProps | Readonly<DrawerItemProps>
+

Inherited from#

+

React.Component<DrawerItemProps>.constructor

+

• new DrawerItem(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsDrawerItemProps
contextany
+

Inherited from#

+

React.Component<DrawerItemProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<DrawerItemProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<DrawerItemProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.drawerparamtoggler/index.html b/v5.2.6/extensions/api/classes/renderer.component.drawerparamtoggler/index.html new file mode 100644 index 0000000000..c37179cb9c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.drawerparamtoggler/index.html @@ -0,0 +1,1550 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DrawerParamToggler - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DrawerParamToggler#

+

Renderer.Component.DrawerParamToggler

+

Hierarchy#

+ +

↳ DrawerParamToggler

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DrawerParamToggler(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDrawerParamTogglerProps | Readonly<DrawerParamTogglerProps>
+

Inherited from#

+

React.Component<DrawerParamTogglerProps, State>.constructor

+

• new DrawerParamToggler(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsDrawerParamTogglerProps
contextany
+

Inherited from#

+

React.Component<DrawerParamTogglerProps, State>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<DrawerParamTogglerProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: State = {}

+

Overrides#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: "open"
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateState | (prevState: Readonly<State>, props: Readonly<DrawerParamTogglerProps>) => State | Pick<State, K> | Pick<State, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

toggle#

+

▸ toggle(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.drawertitle/index.html b/v5.2.6/extensions/api/classes/renderer.component.drawertitle/index.html new file mode 100644 index 0000000000..e3a98d5239 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.drawertitle/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DrawerTitle - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DrawerTitle#

+

Renderer.Component.DrawerTitle

+

Hierarchy#

+ +

↳ DrawerTitle

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DrawerTitle(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDrawerTitleProps | Readonly<DrawerTitleProps>
+

Inherited from#

+

React.Component<DrawerTitleProps>.constructor

+

• new DrawerTitle(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsDrawerTitleProps
contextany
+

Inherited from#

+

React.Component<DrawerTitleProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<DrawerTitleProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<DrawerTitleProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.icon/index.html b/v5.2.6/extensions/api/classes/renderer.component.icon/index.html new file mode 100644 index 0000000000..15949afc62 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.icon/index.html @@ -0,0 +1,1640 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Icon - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Icon#

+

Renderer.Component.Icon

+

Hierarchy#

+ +

↳ Icon

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Icon(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsIconProps | Readonly<IconProps>
+

Inherited from#

+

React.PureComponent<IconProps>.constructor

+

• new Icon(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsIconProps
contextany
+

Inherited from#

+

React.PureComponent<IconProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<IconProps> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+
+

defaultProps#

+

▪ Static defaultProps: IconProps

+

Accessors#

+

isInteractive#

+

• get isInteractive(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

onClick#

+

▸ onClick(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtMouseEvent<Element, MouseEvent>
+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent<any>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<IconProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.input/index.html b/v5.2.6/extensions/api/classes/renderer.component.input/index.html new file mode 100644 index 0000000000..6b6d756cfe --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.input/index.html @@ -0,0 +1,1925 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Input - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Input#

+

Renderer.Component.Input

+

Hierarchy#

+ +

↳ Input

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Input(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsInputProps | Readonly<InputProps>
+

Inherited from#

+

React.Component<InputProps, State>.constructor

+

• new Input(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsInputProps
contextany
+

Inherited from#

+

React.Component<InputProps, State>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

input#

+

• input: InputElement = null

+
+

props#

+

• Readonly props: Readonly<InputProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

setDirtyOnChange#

+

• setDirtyOnChange: () => void & Cancelable

+
+

state#

+

• state: State

+

Overrides#

+

React.Component.state

+
+

validators#

+

• validators: InputValidator[] = []

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

isUncontrolled#

+

• get isUncontrolled(): boolean

+

Returns#

+

boolean

+
+

showMaxLenIndicator#

+

• get showMaxLenIndicator(): boolean

+

Returns#

+

boolean

+
+

themeSelection#

+

• get themeSelection(): Record<string, boolean>

+

Returns#

+

Record<string, boolean>

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

bindRef#

+

▸ bindRef(elem): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
elemInputElement
+

Returns#

+

void

+
+

blur#

+

▸ blur(): void

+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ componentDidUpdate(prevProps): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
prevPropsInputProps
+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

focus#

+

▸ focus(): void

+

Returns#

+

void

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

getValue#

+

▸ getValue(): string

+

Returns#

+

string

+
+

onBlur#

+

▸ onBlur(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtFocusEvent<InputElement>
+

Returns#

+

void

+
+

onChange#

+

▸ onChange(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtChangeEvent<any>
+

Returns#

+

void

+
+

onFocus#

+

▸ onFocus(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtFocusEvent<InputElement>
+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent<InputElement>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

select#

+

▸ select(): void

+

Returns#

+

void

+
+

setDirty#

+

▸ setDirty(dirty?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
dirtybooleantrue
+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: keyof State
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateState | (prevState: Readonly<State>, props: Readonly<InputProps>) => State | Pick<State, K> | Pick<State, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

setValidation#

+

▸ setValidation(errors): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
errorsReactNode[]
+

Returns#

+

void

+
+

setValue#

+

▸ setValue(value?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
valuestring""
+

Returns#

+

void

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

validate#

+

▸ validate(): Promise<void>

+

Returns#

+

Promise<void>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.kubeeventdetails/index.html b/v5.2.6/extensions/api/classes/renderer.component.kubeeventdetails/index.html new file mode 100644 index 0000000000..d50ccd4447 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.kubeeventdetails/index.html @@ -0,0 +1,1536 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeEventDetails - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeEventDetails#

+

Renderer.Component.KubeEventDetails

+

Hierarchy#

+ +

↳ KubeEventDetails

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeEventDetails(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsKubeEventDetailsProps | Readonly<KubeEventDetailsProps>
+

Inherited from#

+

React.Component<KubeEventDetailsProps>.constructor

+

• new KubeEventDetails(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsKubeEventDetailsProps
contextany
+

Inherited from#

+

React.Component<KubeEventDetailsProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<KubeEventDetailsProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): Promise<void>

+

Returns#

+

Promise<void>

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<KubeEventDetailsProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.kubeobjectdetails/index.html b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectdetails/index.html new file mode 100644 index 0000000000..b4bd38fa9b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectdetails/index.html @@ -0,0 +1,1595 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectDetails - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObjectDetails#

+

Renderer.Component.KubeObjectDetails

+

Hierarchy#

+
    +
  • Component
    • +
+

↳ KubeObjectDetails

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObjectDetails(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsObject
+

Overrides#

+

React.Component.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

isLoading#

+

• isLoading: boolean = false

+
+

loader#

+

• loader: IReactionDisposer

+
+

loadingError#

+

• loadingError: ReactNode

+
+

props#

+

• Readonly props: Readonly<Object> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Accessors#

+

object#

+

• get object(): KubeObject<KubeObjectMetadata, any, any>

+

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+
+

path#

+

• get path(): string

+

Returns#

+

string

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<Object>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html new file mode 100644 index 0000000000..28d1946f39 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html @@ -0,0 +1,1596 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectListLayout - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObjectListLayout<K>#

+

Renderer.Component.KubeObjectListLayout

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: KubeObject
+

Hierarchy#

+ +

↳ KubeObjectListLayout

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObjectListLayout<K>(props)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: KubeObject<KubeObjectMetadata, any, any, K>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsKubeObjectListLayoutProps<K>
+

Overrides#

+

React.Component<KubeObjectListLayoutProps<K\>\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<KubeObjectListLayoutProps<K>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

selectedItem#

+

• get selectedItem(): K

+

Returns#

+

K

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<K>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<K>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<K>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<K>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<K>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<K>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<KubeObjectListLayoutProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<K>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmenu/index.html b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmenu/index.html new file mode 100644 index 0000000000..46363dca64 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmenu/index.html @@ -0,0 +1,1703 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMenu - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObjectMenu<T>#

+

Renderer.Component.KubeObjectMenu

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject
+

Hierarchy#

+ +

↳ KubeObjectMenu

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObjectMenu<T>(props)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject<KubeObjectMetadata, any, any, T>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsKubeObjectMenuProps<T> | Readonly<KubeObjectMenuProps<T>>
+

Inherited from#

+

React.Component<KubeObjectMenuProps<T>>.constructor

+

• new KubeObjectMenu<T>(props, context)

+

deprecated

+

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

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject<KubeObjectMetadata, any, any, T>
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsKubeObjectMenuProps<T>
contextany
+

Inherited from#

+

React.Component<KubeObjectMenuProps<T>>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<KubeObjectMenuProps<T>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Accessors#

+

isEditable#

+

• get isEditable(): boolean

+

Returns#

+

boolean

+
+

isRemovable#

+

• get isRemovable(): boolean

+

Returns#

+

boolean

+
+

store#

+

• get store(): KubeObjectStore<KubeObject<KubeObjectMetadata, any, any>>

+

Returns#

+

KubeObjectStore<KubeObject<KubeObjectMetadata, any, any>>

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<T>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<T>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<T>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<T>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<T>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getMenuItems#

+

▸ getMenuItems(): ReactChild[]

+

Returns#

+

ReactChild[]

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<T>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

remove#

+

▸ remove(): Promise<void>

+

Returns#

+

Promise<void>

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderRemoveMessage#

+

▸ renderRemoveMessage(): Element

+

Returns#

+

Element

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<KubeObjectMenuProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<T>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

update#

+

▸ update(): Promise<void>

+

Returns#

+

Promise<void>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmeta/index.html b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmeta/index.html new file mode 100644 index 0000000000..8962d48021 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmeta/index.html @@ -0,0 +1,1576 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMeta - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObjectMeta#

+

Renderer.Component.KubeObjectMeta

+

Hierarchy#

+ +

↳ KubeObjectMeta

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObjectMeta(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsKubeObjectMetaProps | Readonly<KubeObjectMetaProps>
+

Inherited from#

+

React.Component<KubeObjectMetaProps>.constructor

+

• new KubeObjectMeta(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsKubeObjectMetaProps
contextany
+

Inherited from#

+

React.Component<KubeObjectMetaProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<KubeObjectMetaProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultHiddenFields#

+

▪ Static defaultHiddenFields: keyof KubeObjectMetadata[]

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

isHidden#

+

▸ isHidden(field): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
fieldkeyof KubeObjectMetadata
+

Returns#

+

boolean

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<KubeObjectMetaProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.lineprogress/index.html b/v5.2.6/extensions/api/classes/renderer.component.lineprogress/index.html new file mode 100644 index 0000000000..a7558b214c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.lineprogress/index.html @@ -0,0 +1,1548 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LineProgress - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LineProgress#

+

Renderer.Component.LineProgress

+

Hierarchy#

+ +

↳ LineProgress

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new LineProgress(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsLineProgressProps | Readonly<LineProgressProps>
+

Inherited from#

+

React.PureComponent<LineProgressProps>.constructor

+

• new LineProgress(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsLineProgressProps
contextany
+

Inherited from#

+

React.PureComponent<LineProgressProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<LineProgressProps> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+
+

defaultProps#

+

▪ Static defaultProps: LineProgressProps

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<LineProgressProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.mainlayout/index.html b/v5.2.6/extensions/api/classes/renderer.component.mainlayout/index.html new file mode 100644 index 0000000000..3656472a93 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.mainlayout/index.html @@ -0,0 +1,1567 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: MainLayout - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: MainLayout#

+

Renderer.Component.MainLayout

+

Main layout is commonly used as a wrapper for "global pages"

+

link https://api-docs.k8slens.dev/master/extensions/capabilities/common-capabilities/#global-pages

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ MainLayout

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new MainLayout(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new MainLayout(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onSidebarResize#

+

▸ onSidebarResize(width): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
widthnumber
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.menu/index.html b/v5.2.6/extensions/api/classes/renderer.component.menu/index.html new file mode 100644 index 0000000000..322beb0bc5 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.menu/index.html @@ -0,0 +1,1883 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Menu - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Menu#

+

Renderer.Component.Menu

+

Hierarchy#

+ +

↳ Menu

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Menu(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsMenuProps
+

Overrides#

+

React.Component<MenuProps, State\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

elem#

+

• elem: HTMLUListElement

+
+

items#

+

• Protected items: Object = {}

+

Index signature#

+

▪ [index: number]: MenuItem

+
+

opener#

+

• opener: HTMLElement

+
+

props#

+

• Readonly props: Readonly<MenuProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: State = {}

+

Overrides#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

focusableItems#

+

• Protected get focusableItems(): MenuItem[]

+

Returns#

+

MenuItem[]

+
+

focusedItem#

+

• Protected get focusedItem(): MenuItem

+

Returns#

+

MenuItem

+
+

isOpen#

+

• get isOpen(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

bindItemRef#

+

▸ Protected bindItemRef(item, index): void

+

Parameters#

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

Returns#

+

void

+
+

bindRef#

+

▸ Protected bindRef(elem): void

+

Parameters#

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

Returns#

+

void

+
+

close#

+

▸ close(): void

+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

focusNextItem#

+

▸ Protected focusNextItem(reverse?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
reversebooleanfalse
+

Returns#

+

void

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onBlur#

+

▸ onBlur(): void

+

Returns#

+

void

+
+

onClickOutside#

+

▸ onClickOutside(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onContextMenu#

+

▸ onContextMenu(): void

+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onScrollOutside#

+

▸ onScrollOutside(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onWindowResize#

+

▸ onWindowResize(): void

+

Returns#

+

void

+
+

open#

+

▸ open(): void

+

Returns#

+

void

+
+

refreshPosition#

+

▸ refreshPosition(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: "position"
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateState | (prevState: Readonly<State>, props: Readonly<MenuProps>) => State | Pick<State, K> | Pick<State, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

toggle#

+

▸ toggle(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.menuactions/index.html b/v5.2.6/extensions/api/classes/renderer.component.menuactions/index.html new file mode 100644 index 0000000000..f4de2adfba --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.menuactions/index.html @@ -0,0 +1,1585 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: MenuActions - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: MenuActions#

+

Renderer.Component.MenuActions

+

Hierarchy#

+ +

↳ MenuActions

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new MenuActions(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsMenuActionsProps
+

Overrides#

+

React.Component<MenuActionsProps\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

id#

+

• id: string

+
+

isOpen#

+

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

+
+

props#

+

• Readonly props: Readonly<MenuActionsProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: MenuActionsProps

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

remove#

+

▸ remove(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderTriggerIcon#

+

▸ renderTriggerIcon(): Element

+

Returns#

+

Element

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<MenuActionsProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

toggle#

+

▸ toggle(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.menuitem/index.html b/v5.2.6/extensions/api/classes/renderer.component.menuitem/index.html new file mode 100644 index 0000000000..3ec5370b21 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.menuitem/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: MenuItem - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: MenuItem#

+

Renderer.Component.MenuItem

+

Hierarchy#

+ +

↳ MenuItem

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new MenuItem(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsMenuItemProps
+

Overrides#

+

React.Component<MenuItemProps\>.constructor

+

Properties#

+

context#

+

• context: Menu

+

Overrides#

+

React.Component.context

+
+

elem#

+

• elem: HTMLElement

+
+

props#

+

• Readonly props: Readonly<MenuItemProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static contextType: Context<Menu>

+

Overrides#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

isFocusable#

+

• get isFocusable(): boolean

+

Returns#

+

boolean

+
+ +

• get isLink(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

bindRef#

+

▸ Protected bindRef(elem): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
elemHTMLElement
+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onClick#

+

▸ onClick(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtMouseEvent<Element, MouseEvent>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<MenuItemProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.namespaceselect/index.html b/v5.2.6/extensions/api/classes/renderer.component.namespaceselect/index.html new file mode 100644 index 0000000000..eb477bd9cb --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.namespaceselect/index.html @@ -0,0 +1,1587 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceSelect - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NamespaceSelect#

+

Renderer.Component.NamespaceSelect

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ NamespaceSelect

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NamespaceSelect(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps
+

Overrides#

+

React.Component<Props\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

options#

+

• get options(): SelectOption<any>[]

+

Returns#

+

SelectOption<any>[]

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

formatOptionLabel#

+

▸ formatOptionLabel(option): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionSelectOption<any>
+

Returns#

+

Object

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.namespaceselectfilter/index.html b/v5.2.6/extensions/api/classes/renderer.component.namespaceselectfilter/index.html new file mode 100644 index 0000000000..81600be8ac --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.namespaceselectfilter/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceSelectFilter - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NamespaceSelectFilter#

+

Renderer.Component.NamespaceSelectFilter

+

Hierarchy#

+ +

↳ NamespaceSelectFilter

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NamespaceSelectFilter(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSelectProps<any>
+

Overrides#

+

React.Component<SelectProps\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<SelectProps<any>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

isMenuOpen#

+

▪ Static isMenuOpen: IObservableValue<boolean>

+
+

isMultiSelection#

+

▪ Static isMultiSelection: IObservableValue<boolean>

+

Accessors#

+

isMenuOpen#

+

• get isMenuOpen(): boolean

+

Returns#

+

boolean

+

• set isMenuOpen(val): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valboolean
+

Returns#

+

void

+
+

isMultiSelection#

+

• get isMultiSelection(): boolean

+

Returns#

+

boolean

+

• set isMultiSelection(val): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valboolean
+

Returns#

+

void

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<any>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

formatOptionLabel#

+

▸ formatOptionLabel(__namedParameters): ReactNode

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersSelectOption<any>
+

Returns#

+

ReactNode

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<any>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onChange#

+

▸ onChange(__namedParameters): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersSelectOption<any>[]
+

Returns#

+

void

+
+

onClick#

+

▸ onClick(): void

+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(e): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eKeyboardEvent<Element>
+

Returns#

+

void

+
+

onKeyUp#

+

▸ onKeyUp(e): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eKeyboardEvent<Element>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SelectProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.notifications/index.html b/v5.2.6/extensions/api/classes/renderer.component.notifications/index.html new file mode 100644 index 0000000000..4cbb817cc6 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.notifications/index.html @@ -0,0 +1,1715 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Notifications - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Notifications#

+

Renderer.Component.Notifications

+

Hierarchy#

+
    +
  • Component
    • +
+

↳ Notifications

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Notifications(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
props{} | Readonly<Object>
+

Inherited from#

+

React.Component.constructor

+

• new Notifications(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsObject
contextany
+

Inherited from#

+

React.Component.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

elem#

+

• elem: HTMLElement

+
+

props#

+

• Readonly props: Readonly<Object> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getMessage#

+

▸ getMessage(notification): (ReactChild | ReactFragment | ReactPortal)[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
notificationNotification
+

Returns#

+

(ReactChild | ReactFragment | ReactPortal)[]

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

scrollToLastNotification#

+

▸ scrollToLastNotification(): void

+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<Object>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

error#

+

▸ Static error(message, customOpts?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
messageNotificationMessage
customOptsPartial<Notification>
+

Returns#

+

void

+
+

info#

+

▸ Static info(message, customOpts?): () => void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
messageNotificationMessage
customOptsPartial<Notification>
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+
+

ok#

+

▸ Static ok(message): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
messageNotificationMessage
+

Returns#

+

void

+
+

shortInfo#

+

▸ Static shortInfo(message, customOpts?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
messageNotificationMessage
customOptsPartial<Notification>
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.notificationsstore/index.html b/v5.2.6/extensions/api/classes/renderer.component.notificationsstore/index.html new file mode 100644 index 0000000000..152861db20 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.notificationsstore/index.html @@ -0,0 +1,1047 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NotificationsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NotificationsStore#

+

Renderer.Component.NotificationsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NotificationsStore()

+

Properties#

+

autoHideTimers#

+

• Protected autoHideTimers: Map<NotificationId, number>

+
+

notifications#

+

• notifications: IObservableArray<Notification>

+

Methods#

+

add#

+

▸ add(notification): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
notificationNotification
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+
+

addAutoHideTimer#

+

▸ addAutoHideTimer(id): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
idNotificationId
+

Returns#

+

void

+
+

getById#

+

▸ getById(id): Notification

+

Parameters#

+ + + + + + + + + + + + + +
NameType
idNotificationId
+

Returns#

+

Notification

+
+

remove#

+

▸ remove(id): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
idNotificationId
+

Returns#

+

void

+
+

removeAutoHideTimer#

+

▸ removeAutoHideTimer(id): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
idNotificationId
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.pagelayout/index.html b/v5.2.6/extensions/api/classes/renderer.component.pagelayout/index.html new file mode 100644 index 0000000000..381b109147 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.pagelayout/index.html @@ -0,0 +1,1609 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PageLayout - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PageLayout#

+

Renderer.Component.PageLayout

+

PageLayout is deprecated. See MainLayout & SettingLayout

+

deprecated

+

Hierarchy#

+ +

↳ PageLayout

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PageLayout(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSettingLayoutProps | Readonly<SettingLayoutProps>
+

Inherited from#

+

SettingLayout.constructor

+

• new PageLayout(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsSettingLayoutProps
contextany
+

Inherited from#

+

SettingLayout.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

SettingLayout.context

+
+

props#

+

• Readonly props: Readonly<SettingLayoutProps> & Readonly<Object>

+

Inherited from#

+

SettingLayout.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

SettingLayout.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

SettingLayout.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

SettingLayout.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Inherited from#

+

SettingLayout.defaultProps

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

SettingLayout.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<SettingLayoutProps>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.UNSAFE_componentWillUpdate

+
+

back#

+

▸ back(evt?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evt?MouseEvent<Element, MouseEvent> | KeyboardEvent
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.back

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

SettingLayout.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<SettingLayoutProps>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

SettingLayout.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<SettingLayoutProps>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Inherited from#

+

SettingLayout.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<SettingLayoutProps>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

SettingLayout.getSnapshotBeforeUpdate

+
+

onEscapeKey#

+

▸ onEscapeKey(evt): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

SettingLayout.onEscapeKey

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Inherited from#

+

SettingLayout.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SettingLayoutProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

SettingLayout.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

SettingLayout.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.piechart/index.html b/v5.2.6/extensions/api/classes/renderer.component.piechart/index.html new file mode 100644 index 0000000000..b889df4747 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.piechart/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PieChart - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PieChart#

+

Renderer.Component.PieChart

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ PieChart

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PieChart(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new PieChart(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.poddetailslist/index.html b/v5.2.6/extensions/api/classes/renderer.component.poddetailslist/index.html new file mode 100644 index 0000000000..b70fc0f8fe --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.poddetailslist/index.html @@ -0,0 +1,1637 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodDetailsList - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodDetailsList#

+

Renderer.Component.PodDetailsList

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ PodDetailsList

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PodDetailsList(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new PodDetailsList(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: OptionalProps

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

getTableRow#

+

▸ getTableRow(uid): Element

+

Parameters#

+ + + + + + + + + + + + + +
NameType
uidstring
+

Returns#

+

Element

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderCpuUsage#

+

▸ renderCpuUsage(id, usage): string | 0 | Element

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
idstring
usagenumber
+

Returns#

+

string | 0 | Element

+
+

renderMemoryUsage#

+

▸ renderMemoryUsage(id, usage): string | 0 | Element

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
idstring
usagenumber
+

Returns#

+

string | 0 | Element

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.radio/index.html b/v5.2.6/extensions/api/classes/renderer.component.radio/index.html new file mode 100644 index 0000000000..1810a7dae0 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.radio/index.html @@ -0,0 +1,1578 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Radio - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Radio#

+

Renderer.Component.Radio

+

Hierarchy#

+ +

↳ Radio

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Radio(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsRadioProps | Readonly<RadioProps>
+

Inherited from#

+

React.Component<RadioProps>.constructor

+

• new Radio(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsRadioProps
contextany
+

Inherited from#

+

React.Component<RadioProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<RadioProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onChange#

+

▸ onChange(): void

+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(e): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eKeyboardEvent<any>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<RadioProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.radiogroup/index.html b/v5.2.6/extensions/api/classes/renderer.component.radiogroup/index.html new file mode 100644 index 0000000000..114c46192c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.radiogroup/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RadioGroup - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RadioGroup#

+

Renderer.Component.RadioGroup

+

Hierarchy#

+ +

↳ RadioGroup

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new RadioGroup(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsRadioGroupProps | Readonly<RadioGroupProps>
+

Inherited from#

+

React.Component<RadioGroupProps, {}>.constructor

+

• new RadioGroup(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsRadioGroupProps
contextany
+

Inherited from#

+

React.Component<RadioGroupProps, {}>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<RadioGroupProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<RadioGroupProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.searchinput/index.html b/v5.2.6/extensions/api/classes/renderer.component.searchinput/index.html new file mode 100644 index 0000000000..caefa79b63 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.searchinput/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: SearchInput - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: SearchInput#

+

Renderer.Component.SearchInput

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ SearchInput

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new SearchInput(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new SearchInput(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

clear#

+

▸ clear(): void

+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onGlobalKey#

+

▸ onGlobalKey(evt): void

+

Parameters#

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

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent<any>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.select/index.html b/v5.2.6/extensions/api/classes/renderer.component.select/index.html new file mode 100644 index 0000000000..da4d4e68c3 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.select/index.html @@ -0,0 +1,1674 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Select - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Select#

+

Renderer.Component.Select

+

Hierarchy#

+ +

↳ Select

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Select(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSelectProps<any>
+

Overrides#

+

React.Component<SelectProps\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<SelectProps<any>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: SelectProps<any>

+

Accessors#

+

options#

+

• get options(): SelectOption<any>[]

+

Returns#

+

SelectOption<any>[]

+
+

selectedOption#

+

• get selectedOption(): SelectOption<any> | SelectOption<any>[]

+

Returns#

+

SelectOption<any> | SelectOption<any>[]

+
+

themeClass#

+

• get themeClass(): string

+

Returns#

+

string

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<any>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<any>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

isValidOption#

+

▸ Protected isValidOption(opt): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optany
+

Returns#

+

boolean

+
+

onChange#

+

▸ onChange(value, meta): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
valueSelectOption<any>
metaActionMeta<any>
+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent<HTMLElement>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SelectProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.settinglayout/index.html b/v5.2.6/extensions/api/classes/renderer.component.settinglayout/index.html new file mode 100644 index 0000000000..0e3078c84b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.settinglayout/index.html @@ -0,0 +1,1603 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: SettingLayout - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: SettingLayout#

+

Renderer.Component.SettingLayout

+

Layout for settings like pages with navigation

+

Hierarchy#

+ +

↳ SettingLayout

+

↳↳ PageLayout

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new SettingLayout(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSettingLayoutProps | Readonly<SettingLayoutProps>
+

Inherited from#

+

React.Component<SettingLayoutProps>.constructor

+

• new SettingLayout(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsSettingLayoutProps
contextany
+

Inherited from#

+

React.Component<SettingLayoutProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<SettingLayoutProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<SettingLayoutProps>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

back#

+

▸ back(evt?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evt?MouseEvent<Element, MouseEvent> | KeyboardEvent
+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): Promise<void>

+

Returns#

+

Promise<void>

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<SettingLayoutProps>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<SettingLayoutProps>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<SettingLayoutProps>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onEscapeKey#

+

▸ onEscapeKey(evt): void

+

Parameters#

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

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SettingLayoutProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<SettingLayoutProps>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.slider/index.html b/v5.2.6/extensions/api/classes/renderer.component.slider/index.html new file mode 100644 index 0000000000..510709742a --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.slider/index.html @@ -0,0 +1,1548 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Slider - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Slider#

+

Renderer.Component.Slider

+

Hierarchy#

+ +

↳ Slider

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Slider(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSliderProps | Readonly<SliderProps>
+

Inherited from#

+

Component<SliderProps>.constructor

+

• new Slider(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsSliderProps
contextany
+

Inherited from#

+

Component<SliderProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

Component.context

+
+

props#

+

• Readonly props: Readonly<SliderProps> & Readonly<Object>

+

Inherited from#

+

Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SliderProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.spinner/index.html b/v5.2.6/extensions/api/classes/renderer.component.spinner/index.html new file mode 100644 index 0000000000..29032d94c7 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.spinner/index.html @@ -0,0 +1,1567 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Spinner - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Spinner#

+

Renderer.Component.Spinner

+

Hierarchy#

+ +

↳ Spinner

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Spinner(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsSpinnerProps | Readonly<SpinnerProps>
+

Inherited from#

+

React.Component<SpinnerProps, {}>.constructor

+

• new Spinner(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsSpinnerProps
contextany
+

Inherited from#

+

React.Component<SpinnerProps, {}>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<SpinnerProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
centerboolean
singleColorboolean
+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<SpinnerProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.statusbrick/index.html b/v5.2.6/extensions/api/classes/renderer.component.statusbrick/index.html new file mode 100644 index 0000000000..bce24b62d7 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.statusbrick/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StatusBrick - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StatusBrick#

+

Renderer.Component.StatusBrick

+

Hierarchy#

+ +

↳ StatusBrick

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new StatusBrick(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsStatusBrickProps | Readonly<StatusBrickProps>
+

Inherited from#

+

React.Component<StatusBrickProps>.constructor

+

• new StatusBrick(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsStatusBrickProps
contextany
+

Inherited from#

+

React.Component<StatusBrickProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<StatusBrickProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<StatusBrickProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.stepper/index.html b/v5.2.6/extensions/api/classes/renderer.component.stepper/index.html new file mode 100644 index 0000000000..c427e6bf90 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.stepper/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Stepper - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Stepper#

+

Renderer.Component.Stepper

+

Hierarchy#

+ +

↳ Stepper

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Stepper(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsStepperProps | Readonly<StepperProps>
+

Inherited from#

+

React.Component<StepperProps, {}>.constructor

+

• new Stepper(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsStepperProps
contextany
+

Inherited from#

+

React.Component<StepperProps, {}>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<StepperProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<StepperProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.subtitle/index.html b/v5.2.6/extensions/api/classes/renderer.component.subtitle/index.html new file mode 100644 index 0000000000..4e366d8afb --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.subtitle/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: SubTitle - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: SubTitle#

+

Renderer.Component.SubTitle

+

Hierarchy#

+
    +
  • Component<Props>
    • +
+

↳ SubTitle

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new SubTitle(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsProps | Readonly<Props>
+

Inherited from#

+

React.Component<Props>.constructor

+

• new SubTitle(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsProps
contextany
+

Inherited from#

+

React.Component<Props>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<Props> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tab/index.html b/v5.2.6/extensions/api/classes/renderer.component.tab/index.html new file mode 100644 index 0000000000..fb0fdf3632 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tab/index.html @@ -0,0 +1,1669 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Tab - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Tab#

+

Renderer.Component.Tab

+

Hierarchy#

+ +

↳ Tab

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Tab(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTabProps<any> | Readonly<TabProps<any>>
+

Inherited from#

+

React.PureComponent<TabProps>.constructor

+

• new Tab(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsTabProps<any>
contextany
+

Inherited from#

+

React.PureComponent<TabProps>.constructor

+

Properties#

+

context#

+

• context: TabsContextValue<any>

+

Overrides#

+

React.PureComponent.context

+
+

props#

+

• Readonly props: Readonly<TabProps<any>> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

ref#

+

• ref: RefObject<HTMLDivElement>

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static contextType: Context<TabsContextValue<any>>

+

Overrides#

+

React.PureComponent.contextType

+

Accessors#

+

isActive#

+

• get isActive(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<any>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

focus#

+

▸ focus(): void

+

Returns#

+

void

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<any>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

onClick#

+

▸ onClick(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtMouseEvent<HTMLElement, MouseEvent>
+

Returns#

+

void

+
+

onFocus#

+

▸ onFocus(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtFocusEvent<HTMLElement>
+

Returns#

+

void

+
+

onKeyDown#

+

▸ onKeyDown(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent<HTMLElement>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

scrollIntoView#

+

▸ scrollIntoView(): void

+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TabProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.table/index.html b/v5.2.6/extensions/api/classes/renderer.component.table/index.html new file mode 100644 index 0000000000..86e9aa61fd --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.table/index.html @@ -0,0 +1,1702 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Table - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Table<Item>#

+

Renderer.Component.Table

+

Type parameters#

+ + + + + + + + + + + +
Name
Item
+

Hierarchy#

+ +

↳ Table

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Table<Item>(props)

+

Type parameters#

+ + + + + + + + + + + +
Name
Item
+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTableProps<Item>
+

Overrides#

+

React.Component<TableProps<Item\>\>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<TableProps<Item>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: TableProps<any>

+

Accessors#

+

sortParams#

+

• get sortParams(): Partial<TableSortParams>

+

Returns#

+

Partial<TableSortParams>

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Item>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Item>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Item>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<Item>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Item>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Item>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

getSorted#

+

▸ getSorted(items): any[]

+

Parameters#

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

Returns#

+

any[]

+
+

onSort#

+

▸ Protected onSort(__namedParameters): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersTableSortParams
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderHead#

+

▸ renderHead(): ReactElement<TableHeadProps, string | JSXElementConstructor<any>>

+

Returns#

+

ReactElement<TableHeadProps, string | JSXElementConstructor<any>>

+
+

renderRows#

+

▸ renderRows(): Object

+

Returns#

+

Object

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TableProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Item>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

sort#

+

▸ sort(colName): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
colNamestring
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tablecell/index.html b/v5.2.6/extensions/api/classes/renderer.component.tablecell/index.html new file mode 100644 index 0000000000..749fda4f90 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tablecell/index.html @@ -0,0 +1,1627 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: TableCell - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: TableCell#

+

Renderer.Component.TableCell

+

Hierarchy#

+ +

↳ TableCell

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new TableCell(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTableCellProps | Readonly<TableCellProps>
+

Inherited from#

+

React.Component<TableCellProps>.constructor

+

• new TableCell(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsTableCellProps
contextany
+

Inherited from#

+

React.Component<TableCellProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<TableCellProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Accessors#

+

isSortable#

+

• get isSortable(): boolean

+

Returns#

+

boolean

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onClick#

+

▸ onClick(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtMouseEvent<HTMLDivElement, MouseEvent>
+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderCheckbox#

+

▸ renderCheckbox(): Element

+

Returns#

+

Element

+
+

renderSortIcon#

+

▸ renderSortIcon(): Element

+

Returns#

+

Element

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TableCellProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tablehead/index.html b/v5.2.6/extensions/api/classes/renderer.component.tablehead/index.html new file mode 100644 index 0000000000..0911f616d2 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tablehead/index.html @@ -0,0 +1,1548 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: TableHead - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: TableHead#

+

Renderer.Component.TableHead

+

Hierarchy#

+ +

↳ TableHead

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new TableHead(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTableHeadProps | Readonly<TableHeadProps>
+

Inherited from#

+

React.Component<TableHeadProps>.constructor

+

• new TableHead(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsTableHeadProps
contextany
+

Inherited from#

+

React.Component<TableHeadProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<TableHeadProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: TableHeadProps

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TableHeadProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tablerow/index.html b/v5.2.6/extensions/api/classes/renderer.component.tablerow/index.html new file mode 100644 index 0000000000..15b7be5bf3 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tablerow/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: TableRow - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: TableRow#

+

Renderer.Component.TableRow

+

Hierarchy#

+ +

↳ TableRow

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new TableRow(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTableRowProps | Readonly<TableRowProps>
+

Inherited from#

+

React.Component<TableRowProps>.constructor

+

• new TableRow(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsTableRowProps
contextany
+

Inherited from#

+

React.Component<TableRowProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<TableRowProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TableRowProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tabs/index.html b/v5.2.6/extensions/api/classes/renderer.component.tabs/index.html new file mode 100644 index 0000000000..241f39517f --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tabs/index.html @@ -0,0 +1,1576 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Tabs - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Tabs#

+

Renderer.Component.Tabs

+

Hierarchy#

+ +

↳ Tabs

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Tabs(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTabsProps<any> | Readonly<TabsProps<any>>
+

Inherited from#

+

React.PureComponent<TabsProps>.constructor

+

• new Tabs(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsTabsProps<any>
contextany
+

Inherited from#

+

React.PureComponent<TabsProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.PureComponent.context

+
+

elem#

+

• elem: HTMLElement

+
+

props#

+

• Readonly props: Readonly<TabsProps<any>> & Readonly<Object>

+

Inherited from#

+

React.PureComponent.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.PureComponent.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.PureComponent.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.PureComponent.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.UNSAFE_componentWillUpdate

+
+

bindRef#

+

▸ Protected bindRef(elem): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
elemHTMLElement
+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<any>>
prevStateReadonly<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.PureComponent.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<any>>
prevStateReadonly<Object>
+

Returns#

+

any

+

Inherited from#

+

React.PureComponent.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.PureComponent.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TabsProps\>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.PureComponent.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<any>>
nextStateReadonly<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.PureComponent.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.terminalstore/index.html b/v5.2.6/extensions/api/classes/renderer.component.terminalstore/index.html new file mode 100644 index 0000000000..7ccb96c137 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.terminalstore/index.html @@ -0,0 +1,1271 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: TerminalStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: TerminalStore#

+

Renderer.Component.TerminalStore

+

Hierarchy#

+ +

↳ TerminalStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new TerminalStore()

+

Overrides#

+

Singleton.constructor

+

Properties#

+

connections#

+

• Protected connections: ObservableMap<string, TerminalApi>

+
+

terminals#

+

• Protected terminals: Map<string, Terminal>

+

Methods#

+

connect#

+

▸ connect(tabId): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

void

+
+

disconnect#

+

▸ disconnect(tabId): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

void

+
+

getTerminal#

+

▸ getTerminal(tabId): Terminal

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

Terminal

+
+

isConnected#

+

▸ isConnected(tabId): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

boolean

+
+

isDisconnected#

+

▸ isDisconnected(tabId): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

boolean

+
+

reconnect#

+

▸ reconnect(tabId): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabIdstring
+

Returns#

+

void

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+
+

sendCommand#

+

▸ sendCommand(command, options?): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
commandstring
optionsObject
options.enter?boolean
options.newTab?boolean
options.tabId?string
+

Returns#

+

Promise<void>

+
+

createInstance#

+

▸ Static createInstance<T, R>(...args): T

+

Creates the single instance of the child class if one was not already created.

+

Multiple calls will return the same instance. +Essentially throwing away the arguments to the subsequent calls.

+

Note: this is a racy function, if two (or more) calls are racing to call this function +only the first's arguments will be used.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
...argsRThe constructor arguments for the child class
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

Singleton.createInstance

+
+

getInstance#

+

▸ Static getInstance<T, R>(strict): T

+

Get the instance of the child class that was previously created.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
strictbooleanIf false will return undefined instead of throwing when an instance doesn't exist. Default: true
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

Singleton.getInstance

+
+

resetInstance#

+

▸ Static resetInstance(): void

+

Delete the instance of the child class.

+

Note: this doesn't prevent callers of getInstance from storing the result in a global.

+

There is no way in JS or TS to prevent globals like that.

+

Returns#

+

void

+

Inherited from#

+

Singleton.resetInstance

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.tooltip/index.html b/v5.2.6/extensions/api/classes/renderer.component.tooltip/index.html new file mode 100644 index 0000000000..fd24c44a50 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.tooltip/index.html @@ -0,0 +1,1768 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Tooltip - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Tooltip#

+

Renderer.Component.Tooltip

+

Hierarchy#

+ +

↳ Tooltip

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Tooltip(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsTooltipProps
+

Overrides#

+

React.Component<TooltipProps\>.constructor

+

Properties#

+

activePosition#

+

• activePosition: TooltipPosition

+
+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

elem#

+

• elem: HTMLElement

+
+

isVisible#

+

• isVisible: boolean = !!this.props.visible

+
+

props#

+

• Readonly props: Readonly<TooltipProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: object

+

Accessors#

+

hoverTarget#

+

• get hoverTarget(): HTMLElement

+

Returns#

+

HTMLElement

+
+

targetElem#

+

• get targetElem(): HTMLElement

+

Returns#

+

HTMLElement

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

bindRef#

+

▸ bindRef(elem): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
elemHTMLElement
+

Returns#

+

void

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getPosition#

+

▸ Protected getPosition(position, tooltipBounds, targetBounds): Object

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
positionTooltipPosition
tooltipBoundsDOMRect
targetBoundsDOMRect
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
bottomnumber
leftnumber
rightnumber
topnumber
+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

onEnterTarget#

+

▸ Protected onEnterTarget(): void

+

Returns#

+

void

+
+

onLeaveTarget#

+

▸ Protected onLeaveTarget(): void

+

Returns#

+

void

+
+

refreshPosition#

+

▸ refreshPosition(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setPosition#

+

▸ Protected setPosition(pos): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
posObject
pos.leftnumber
pos.topnumber
+

Returns#

+

void

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<TooltipProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.wizard/index.html b/v5.2.6/extensions/api/classes/renderer.component.wizard/index.html new file mode 100644 index 0000000000..23fb37b38e --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.wizard/index.html @@ -0,0 +1,1710 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Wizard - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Wizard#

+

Renderer.Component.Wizard

+

Hierarchy#

+ +

↳ Wizard

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Wizard(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsWizardProps | Readonly<WizardProps>
+

Inherited from#

+

React.Component<WizardProps, State>.constructor

+

• new Wizard(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsWizardProps
contextany
+

Inherited from#

+

React.Component<WizardProps, State>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<WizardProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: State

+

Overrides#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Accessors#

+

step#

+

• get step(): number

+

Returns#

+

number

+

• set step(step): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
stepnumber
+

Returns#

+

void

+
+

steps#

+

• get steps(): ReactElement<WizardStepProps<any>, string | JSXElementConstructor<any>>[]

+

Returns#

+

ReactElement<WizardStepProps<any>, string | JSXElementConstructor<any>>[]

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

firstStep#

+

▸ firstStep(): any

+

Returns#

+

any

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

getValidStep#

+

▸ Protected getValidStep(step): number

+

Parameters#

+ + + + + + + + + + + + + +
NameType
stepnumber
+

Returns#

+

number

+
+

isFirstStep#

+

▸ isFirstStep(): boolean

+

Returns#

+

boolean

+
+

isLastStep#

+

▸ isLastStep(): boolean

+

Returns#

+

boolean

+
+

lastStep#

+

▸ lastStep(): any

+

Returns#

+

any

+
+

nextStep#

+

▸ nextStep(): any

+

Returns#

+

any

+
+

prevStep#

+

▸ prevStep(): any

+

Returns#

+

any

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: "step"
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateState | (prevState: Readonly<State>, props: Readonly<WizardProps>) => State | Pick<State, K> | Pick<State, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.wizardlayout/index.html b/v5.2.6/extensions/api/classes/renderer.component.wizardlayout/index.html new file mode 100644 index 0000000000..f52f15a5bc --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.wizardlayout/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: WizardLayout - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: WizardLayout#

+

Renderer.Component.WizardLayout

+

Hierarchy#

+ +

↳ WizardLayout

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new WizardLayout(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsWizardLayoutProps | Readonly<WizardLayoutProps>
+

Inherited from#

+

React.Component<WizardLayoutProps>.constructor

+

• new WizardLayout(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsWizardLayoutProps
contextany
+

Inherited from#

+

React.Component<WizardLayoutProps>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<WizardLayoutProps> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: Readonly<Object>

+

Inherited from#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<Object>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ Optional componentWillUnmount(): void

+

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

+

Inherited from#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<Object>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<Object>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: never
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
state{} | (prevState: Readonly<Object>, props: Readonly<WizardLayoutProps>) => {} | Pick<Object, K> | Pick<Object, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<Object>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.component.wizardstep/index.html b/v5.2.6/extensions/api/classes/renderer.component.wizardstep/index.html new file mode 100644 index 0000000000..9ac9832442 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.component.wizardstep/index.html @@ -0,0 +1,1598 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: WizardStep - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: WizardStep#

+

Renderer.Component.WizardStep

+

Hierarchy#

+ +

↳ WizardStep

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new WizardStep(props)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsWizardStepProps<any> | Readonly<WizardStepProps<any>>
+

Inherited from#

+

React.Component<WizardStepProps, WizardStepState>.constructor

+

• new WizardStep(props, context)

+

deprecated

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
propsWizardStepProps<any>
contextany
+

Inherited from#

+

React.Component<WizardStepProps, WizardStepState>.constructor

+

Properties#

+

context#

+

• context: any

+

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

+

Inherited from#

+

React.Component.context

+
+

props#

+

• Readonly props: Readonly<WizardStepProps<any>> & Readonly<Object>

+

Inherited from#

+

React.Component.props

+
+

refs#

+

• refs: Object

+

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

+

Index signature#

+

▪ [key: string]: ReactInstance

+

Inherited from#

+

React.Component.refs

+
+

state#

+

• state: WizardStepState = {}

+

Overrides#

+

React.Component.state

+
+

contextType#

+

▪ Static Optional contextType: Context<any>

+

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

+

Inherited from#

+

React.Component.contextType

+
+

defaultProps#

+

▪ Static defaultProps: WizardStepProps<any>

+

Methods#

+

UNSAFE_componentWillMount#

+

▸ Optional UNSAFE_componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.UNSAFE_componentWillMount

+
+

UNSAFE_componentWillReceiveProps#

+

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillReceiveProps

+
+

UNSAFE_componentWillUpdate#

+

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<WizardStepState>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.UNSAFE_componentWillUpdate

+
+

componentDidCatch#

+

▸ Optional componentDidCatch(error, errorInfo): void

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
errorError
errorInfoErrorInfo
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidCatch

+
+

componentDidMount#

+

▸ Optional componentDidMount(): void

+

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidMount

+
+

componentDidUpdate#

+

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

+

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<any>>
prevStateReadonly<WizardStepState>
snapshot?any
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentDidUpdate

+
+

componentWillMount#

+

▸ Optional componentWillMount(): void

+

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

+

Inherited from#

+

React.Component.componentWillMount

+
+

componentWillReceiveProps#

+

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

+

Called when the component may be receiving new props. +React may 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<any>>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillReceiveProps

+
+

componentWillUnmount#

+

▸ componentWillUnmount(): void

+

Returns#

+

void

+

Overrides#

+

React.Component.componentWillUnmount

+
+

componentWillUpdate#

+

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

+

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<any>>
nextStateReadonly<WizardStepState>
nextContextany
+

Returns#

+

void

+

Inherited from#

+

React.Component.componentWillUpdate

+
+

forceUpdate#

+

▸ forceUpdate(callback?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.forceUpdate

+
+

getSnapshotBeforeUpdate#

+

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

+

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<any>>
prevStateReadonly<WizardStepState>
+

Returns#

+

any

+

Inherited from#

+

React.Component.getSnapshotBeforeUpdate

+
+

next#

+

▸ next(): void

+

Returns#

+

void

+
+

prev#

+

▸ prev(): void

+

Returns#

+

void

+
+

render#

+

▸ render(): Element

+

Returns#

+

Element

+

Overrides#

+

React.Component.render

+
+

renderLoading#

+

▸ renderLoading(): Element

+

Returns#

+

Element

+
+

setState#

+

▸ setState<K>(state, callback?): void

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: "waiting"
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
stateWizardStepState | (prevState: Readonly<WizardStepState>, props: Readonly<WizardStepProps\>) => WizardStepState | Pick<WizardStepState, K> | Pick<WizardStepState, K>
callback?() => void
+

Returns#

+

void

+

Inherited from#

+

React.Component.setState

+
+

shouldComponentUpdate#

+

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

+

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<any>>
nextStateReadonly<WizardStepState>
nextContextany
+

Returns#

+

boolean

+

Inherited from#

+

React.Component.shouldComponentUpdate

+
+

submit#

+

▸ submit(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.ipc/index.html b/v5.2.6/extensions/api/classes/renderer.ipc/index.html new file mode 100644 index 0000000000..c4e1949231 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.ipc/index.html @@ -0,0 +1,1180 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Ipc - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Ipc#

+

Renderer.Ipc

+

Hierarchy#

+
    +
  • IpcRegistrar
    • +
+

↳ Ipc

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Ipc(extension)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
extensionLensExtension
+

Overrides#

+

IpcRegistrar.constructor

+

Properties#

+

[IpcPrefix]#

+

• Readonly [IpcPrefix]: string

+

Inherited from#

+

IpcRegistrar.__@IpcPrefix@43866

+
+

extension#

+

• Protected extension: LensExtension

+

Inherited from#

+

IpcRegistrar.extension

+

Methods#

+

broadcast#

+

▸ broadcast(channel, ...args): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe channel to broadcast to your whole extension, both main and renderer
...argsany[]The arguments passed to all listeners
+

Returns#

+

void

+

Inherited from#

+

IpcRegistrar.broadcast

+
+

invoke#

+

▸ invoke(channel, ...args): Promise<any>

+

Request main to execute its function over the channel channel. +This function only interacts with functions registered via Ipc.IpcMain.handleRpc +An error will be thrown if no function has been registered on main with this channel ID.

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe channel to invoke a RPC on
...argsany[]The arguments to pass to the RPC
+

Returns#

+

Promise<any>

+

A promise of the resulting value

+
+

listen#

+

▸ listen(channel, listener): Disposer

+

Listen for broadcasts within your extension. +If the lifetime of the listener should be tied to the mounted lifetime of +a component then putting the returned value in a disposeOnUnmount call will suffice.

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
channelstringThe channel to listen for broadcasts on
listener(event: IpcRendererEvent, ...args: any[]) => anyThe function that will be called with the arguments of the broadcast
+

Returns#

+

Disposer

+

An optional disposer, Lens will cleanup even if this is not called

+
+

createInstance#

+

▸ Static createInstance<T, R>(...args): T

+

Creates the single instance of the child class if one was not already created.

+

Multiple calls will return the same instance. +Essentially throwing away the arguments to the subsequent calls.

+

Note: this is a racy function, if two (or more) calls are racing to call this function +only the first's arguments will be used.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
...argsRThe constructor arguments for the child class
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

IpcRegistrar.createInstance

+
+

getInstance#

+

▸ Static getInstance<T, R>(strict): T

+

Get the instance of the child class that was previously created.

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
TT
RR: any[]
+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
strictbooleanIf false will return undefined instead of throwing when an instance doesn't exist. Default: true
+

Returns#

+

T

+

An instance of the child class

+

Inherited from#

+

IpcRegistrar.getInstance

+
+

resetInstance#

+

▸ Static resetInstance(): void

+

Delete the instance of the child class.

+

Note: this doesn't prevent callers of getInstance from storing the result in a global.

+

There is no way in JS or TS to prevent globals like that.

+

Returns#

+

void

+

Inherited from#

+

IpcRegistrar.resetInstance

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrole/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrole/index.html new file mode 100644 index 0000000000..14d6a2e7db --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrole/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRole - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ClusterRole#

+

Renderer.K8sApi.ClusterRole

+

Hierarchy#

+ +

↳ ClusterRole

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ClusterRole(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

rules#

+

• rules: { apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

+
+

kind#

+

▪ Static kind: string = "ClusterRole"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getRules#

+

▸ getRules(): { apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+

Returns#

+

{ apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ClusterRole>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html new file mode 100644 index 0000000000..0718c22731 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrolebinding/index.html @@ -0,0 +1,1738 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRoleBinding - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ClusterRoleBinding#

+

Renderer.K8sApi.ClusterRoleBinding

+

Hierarchy#

+ +

↳ ClusterRoleBinding

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ClusterRoleBinding(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

roleRef#

+

• roleRef: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
apiGroup?string
kindstring
namestring
+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

subjects#

+

• Optional subjects: ClusterRoleBindingSubject[]

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterrolebindings"

+
+

kind#

+

▪ Static kind: string = "ClusterRoleBinding"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSubjectNames#

+

▸ getSubjectNames(): string

+

Returns#

+

string

+
+

getSubjects#

+

▸ getSubjects(): ClusterRoleBindingSubject[]

+

Returns#

+

ClusterRoleBindingSubject[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ClusterRoleBinding>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.configmap/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.configmap/index.html new file mode 100644 index 0000000000..329f88a95c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.configmap/index.html @@ -0,0 +1,1693 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMap - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ConfigMap#

+

Renderer.K8sApi.ConfigMap

+

Hierarchy#

+ +

↳ ConfigMap

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ConfigMap(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

data#

+

• data: Object

+

Index signature#

+

▪ [param: string]: string

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/configmaps"

+
+

kind#

+

▪ Static kind: string = "ConfigMap"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getKeys#

+

▸ getKeys(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ConfigMap>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html new file mode 100644 index 0000000000..b6b4cf4e66 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMapsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ConfigMapsStore#

+

Renderer.K8sApi.ConfigMapsStore

+

Hierarchy#

+ +

↳ ConfigMapsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ConfigMapsStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<ConfigMap>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<ConfigMap>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<ConfigMap>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<ConfigMap, void, undefined>

+

Returns#

+

Generator<ConfigMap, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ConfigMap>
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ConfigMap>
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): ConfigMap[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsConfigMap[]
+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): ConfigMap[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): ConfigMap

+

Parameters#

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

Returns#

+

ConfigMap

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): ConfigMap[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): ConfigMap

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

ConfigMap

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): ConfigMap

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

ConfigMap

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): ConfigMap[]

+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsConfigMap[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

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

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsConfigMap[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | ConfigMap[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | ConfigMap[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<ConfigMap[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<ConfigMap>
+

Returns#

+

Promise<ConfigMap[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): ConfigMap[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsConfigMap[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemConfigMap
patchPatch
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | ConfigMap[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | ConfigMap[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemConfigMap
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): ConfigMap[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsConfigMap[]the items to be sorted (default: the current items in this store)
sorting(item: ConfigMap) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

ConfigMap[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsConfigMap[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemConfigMap
dataPartial<ConfigMap>
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<ConfigMap>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemConfigMap
request() => Promise<ConfigMap>
+

Returns#

+

Promise<ConfigMap>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html new file mode 100644 index 0000000000..94c754f2ff --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html @@ -0,0 +1,2391 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CRDResourceStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CRDResourceStore<K>#

+

Renderer.K8sApi.CRDResourceStore

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: KubeObject
+

Hierarchy#

+ +

↳ CRDResourceStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CRDResourceStore<K>(api)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: KubeObject<KubeObjectMetadata, any, any, K>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
apiKubeApi<K>
+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<K>

+

Inherited from#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<K>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<K, void, undefined>

+

Returns#

+

Generator<K, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<K>
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<K>
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): K[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsK[]
+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): K[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): K

+

Parameters#

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

Returns#

+

K

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): K[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): K

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

K

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): K

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

K

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): K[]

+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsK[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemK
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsK[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | K[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | K[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<K[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<K>
+

Returns#

+

Promise<K[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): K[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsK[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemK
patchPatch
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | K[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | K[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemK
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemK
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemK
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): K[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsK[]the items to be sorted (default: the current items in this store)
sorting(item: K) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

K[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemK
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsK[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemK
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemK
dataPartial<K>
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<K>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemK
request() => Promise<K>
+

Returns#

+

Promise<K>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.crdstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.crdstore/index.html new file mode 100644 index 0000000000..5a17b8976e --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.crdstore/index.html @@ -0,0 +1,2400 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CRDStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CRDStore#

+

Renderer.K8sApi.CRDStore

+

Hierarchy#

+ +

↳ CRDStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CRDStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<CustomResourceDefinition>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

groups#

+

• get groups(): Record<string, CustomResourceDefinition[]>

+

Returns#

+

Record<string, CustomResourceDefinition[]>

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<CustomResourceDefinition, void, undefined>

+

Returns#

+

Generator<CustomResourceDefinition, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<CustomResourceDefinition>
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<CustomResourceDefinition>
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): CustomResourceDefinition[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsCustomResourceDefinition[]
+

Returns#

+

CustomResourceDefinition[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): CustomResourceDefinition[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

CustomResourceDefinition[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getByGroup#

+

▸ getByGroup(group, pluralName): CustomResourceDefinition

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
groupstring
pluralNamestring
+

Returns#

+

CustomResourceDefinition

+
+

getById#

+

▸ getById(id): CustomResourceDefinition

+

Parameters#

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

Returns#

+

CustomResourceDefinition

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): CustomResourceDefinition[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

CustomResourceDefinition[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): CustomResourceDefinition

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

CustomResourceDefinition

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByObject#

+

▸ getByObject(obj): CustomResourceDefinition

+

Parameters#

+ + + + + + + + + + + + + +
NameType
objKubeObject<KubeObjectMetadata, any, any>
+

Returns#

+

CustomResourceDefinition

+
+

getByPath#

+

▸ getByPath(path): CustomResourceDefinition

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

CustomResourceDefinition

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): CustomResourceDefinition[]

+

Returns#

+

CustomResourceDefinition[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsCustomResourceDefinition[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

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

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsCustomResourceDefinition[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | CustomResourceDefinition[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | CustomResourceDefinition[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<CustomResourceDefinition[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<CustomResourceDefinition>
+

Returns#

+

Promise<CustomResourceDefinition[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): CustomResourceDefinition[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsCustomResourceDefinition[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

CustomResourceDefinition[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
patchPatch
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | CustomResourceDefinition[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | CustomResourceDefinition[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items): CustomResourceDefinition[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsCustomResourceDefinition[]
+

Returns#

+

CustomResourceDefinition[]

+

Overrides#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsCustomResourceDefinition[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
dataPartial<CustomResourceDefinition>
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<CustomResourceDefinition>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
request() => Promise<CustomResourceDefinition>
+

Returns#

+

Promise<CustomResourceDefinition>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjob/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjob/index.html new file mode 100644 index 0000000000..ccffb851f0 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjob/index.html @@ -0,0 +1,1842 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CronJob - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CronJob#

+

Renderer.K8sApi.CronJob

+

Hierarchy#

+ +

↳ CronJob

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CronJob(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
concurrencyPolicystring
failedJobsHistoryLimitnumber
jobTemplateObject
jobTemplate.metadataObject
jobTemplate.metadata.annotations?Object
jobTemplate.metadata.creationTimestamp?string
jobTemplate.metadata.labels?Object
jobTemplate.specObject
jobTemplate.spec.templateObject
jobTemplate.spec.template.metadataObject
jobTemplate.spec.template.metadata.creationTimestamp?string
jobTemplate.spec.template.specObject
jobTemplate.spec.template.spec.containersIPodContainer[]
jobTemplate.spec.template.spec.dnsPolicystring
jobTemplate.spec.template.spec.hostPIDboolean
jobTemplate.spec.template.spec.restartPolicystring
jobTemplate.spec.template.spec.schedulerNamestring
jobTemplate.spec.template.spec.terminationGracePeriodSecondsnumber
schedulestring
successfulJobsHistoryLimitnumber
suspendboolean
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
lastScheduleTime?string
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/batch/v1beta1/cronjobs"

+
+

kind#

+

▪ Static kind: string = "CronJob"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getLastScheduleTime#

+

▸ getLastScheduleTime(): string

+

Returns#

+

string

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSchedule#

+

▸ getSchedule(): string

+

Returns#

+

string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSuspendFlag#

+

▸ getSuspendFlag(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

isNeverRun#

+

▸ isNeverRun(): boolean

+

Returns#

+

boolean

+
+

isSuspend#

+

▸ isSuspend(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<CronJob>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html new file mode 100644 index 0000000000..bb74199c6a --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html @@ -0,0 +1,2385 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CronJobStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CronJobStore#

+

Renderer.K8sApi.CronJobStore

+

Hierarchy#

+ +

↳ CronJobStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CronJobStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: CronJobApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<CronJob>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<CronJob, void, undefined>

+

Returns#

+

Generator<CronJob, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<CronJob>
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<CronJob>
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): CronJob[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsCronJob[]
+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getActiveJobsNum#

+

▸ getActiveJobsNum(cronJob): number

+

Parameters#

+ + + + + + + + + + + + + +
NameType
cronJobCronJob
+

Returns#

+

number

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): CronJob[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): CronJob

+

Parameters#

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

Returns#

+

CronJob

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): CronJob[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): CronJob

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

CronJob

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): CronJob

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

CronJob

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): CronJob[]

+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ getStatuses(cronJobs?): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
cronJobs?CronJob[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
schedulednumber
suspendednumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

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

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsCronJob[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | CronJob[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | CronJob[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<CronJob[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<CronJob>
+

Returns#

+

Promise<CronJob[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): CronJob[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsCronJob[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCronJob
patchPatch
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | CronJob[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | CronJob[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCronJob
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): CronJob[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsCronJob[]the items to be sorted (default: the current items in this store)
sorting(item: CronJob) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

CronJob[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsCronJob[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCronJob
dataPartial<CronJob>
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<CronJob>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemCronJob
request() => Promise<CronJob>
+

Returns#

+

Promise<CronJob>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html new file mode 100644 index 0000000000..58fa42362d --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.customresourcedefinition/index.html @@ -0,0 +1,2028 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CustomResourceDefinition - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CustomResourceDefinition#

+

Renderer.K8sApi.CustomResourceDefinition

+

Hierarchy#

+ +

↳ CustomResourceDefinition

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new CustomResourceDefinition(data)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataCRDApiData
+

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
additionalPrinterColumns?AdditionalPrinterColumnsV1Beta[]
conversionObject
conversion.strategy?string
conversion.webhook?any
groupstring
namesObject
names.kindstring
names.listKindstring
names.pluralstring
names.singularstring
scopestring
validation?object
version?string
versions?CRDVersion[]
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
acceptedNamesObject
acceptedNames.kindstring
acceptedNames.listKindstring
acceptedNames.pluralstring
acceptedNames.shortNamesstring[]
acceptedNames.singularstring
conditions{ lastTransitionTime: string ; message: string ; reason: string ; status: string ; type?: string }[]
storedVersionsstring[]
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"

+
+

kind#

+

▪ Static kind: string = "CustomResourceDefinition"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getConditions#

+

▸ getConditions(): { isReady: boolean ; lastTransitionTime: string ; message: string ; reason: string ; status: string ; tooltip: string ; type?: string }[]

+

Returns#

+

{ isReady: boolean ; lastTransitionTime: string ; message: string ; reason: string ; status: string ; tooltip: string ; type?: string }[]

+
+

getConversion#

+

▸ getConversion(): string

+

Returns#

+

string

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getGroup#

+

▸ getGroup(): string

+

Returns#

+

string

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNames#

+

▸ getNames(): Object

+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
kindstring
listKindstring
pluralstring
singularstring
+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getPluralName#

+

▸ getPluralName(): string

+

Returns#

+

string

+
+

getPreferedVersion#

+

▸ getPreferedVersion(): CRDVersion

+

Returns#

+

CRDVersion

+
+

getPrinterColumns#

+

▸ getPrinterColumns(ignorePriority?): AdditionalPrinterColumnsV1[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
ignorePrioritybooleantrue
+

Returns#

+

AdditionalPrinterColumnsV1[]

+
+

getResourceApiBase#

+

▸ getResourceApiBase(): string

+

Returns#

+

string

+
+

getResourceKind#

+

▸ getResourceKind(): string

+

Returns#

+

string

+
+

getResourceTitle#

+

▸ getResourceTitle(): string

+

Returns#

+

string

+
+

getResourceUrl#

+

▸ getResourceUrl(): string

+

Returns#

+

string

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getScope#

+

▸ getScope(): string

+

Returns#

+

string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getStoredVersions#

+

▸ getStoredVersions(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getValidation#

+

▸ getValidation(): string

+

Returns#

+

string

+
+

getVersion#

+

▸ getVersion(): string

+

Returns#

+

string

+
+

isNamespaced#

+

▸ isNamespaced(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<CustomResourceDefinition>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonset/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonset/index.html new file mode 100644 index 0000000000..842f480a20 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonset/index.html @@ -0,0 +1,1920 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSet - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DaemonSet#

+

Renderer.K8sApi.DaemonSet

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ DaemonSet

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DaemonSet(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
revisionHistoryLimitnumber
selectorObject
selector.matchLabelsObject
templateObject
template.metadataObject
template.metadata.creationTimestamp?string
template.metadata.labelsObject
template.metadata.labels.namestring
template.specObject
template.spec.affinity?IAffinity
template.spec.containersIPodContainer[]
template.spec.dnsPolicystring
template.spec.hostPIDboolean
template.spec.initContainers?IPodContainer[]
template.spec.nodeSelector?Object
template.spec.restartPolicystring
template.spec.schedulerNamestring
template.spec.securityContextObject
template.spec.terminationGracePeriodSecondsnumber
template.spec.tolerations{ effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]
updateStrategyObject
updateStrategy.rollingUpdateObject
updateStrategy.rollingUpdate.maxUnavailablenumber
updateStrategy.typestring
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
currentNumberSchedulednumber
desiredNumberSchedulednumber
numberAvailablenumber
numberMisschedulednumber
numberReadynumber
numberUnavailablenumber
observedGenerationnumber
updatedNumberSchedulednumber
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/apps/v1/daemonsets"

+
+

kind#

+

▪ Static kind: string = "DaemonSet"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Inherited from#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getImages#

+

▸ getImages(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): IToleration[]

+

Returns#

+

IToleration[]

+

Inherited from#

+

WorkloadKubeObject.getTolerations

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<DaemonSet>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html new file mode 100644 index 0000000000..254373208b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html @@ -0,0 +1,2389 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSetStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DaemonSetStore#

+

Renderer.K8sApi.DaemonSetStore

+

Hierarchy#

+ +

↳ DaemonSetStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DaemonSetStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: DaemonSetApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<DaemonSet>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<DaemonSet, void, undefined>

+

Returns#

+

Generator<DaemonSet, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<DaemonSet>
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<DaemonSet>
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): DaemonSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsDaemonSet[]
+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): DaemonSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): DaemonSet

+

Parameters#

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

Returns#

+

DaemonSet

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): DaemonSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): DaemonSet

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

DaemonSet

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): DaemonSet

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

DaemonSet

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getChildPods#

+

▸ getChildPods(daemonSet): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
daemonSetDaemonSet
+

Returns#

+

Pod[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): DaemonSet[]

+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ getStatuses(daemonSets?): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
daemonSets?DaemonSet[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + +
NameType
failednumber
pendingnumber
runningnumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsDaemonSet[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | DaemonSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | DaemonSet[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<DaemonSet[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<DaemonSet>
+

Returns#

+

Promise<DaemonSet[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): DaemonSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsDaemonSet[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDaemonSet
patchPatch
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | DaemonSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | DaemonSet[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDaemonSet
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): DaemonSet[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsDaemonSet[]the items to be sorted (default: the current items in this store)
sorting(item: DaemonSet) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

DaemonSet[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsDaemonSet[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDaemonSet
dataPartial<DaemonSet>
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<DaemonSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDaemonSet
request() => Promise<DaemonSet>
+

Returns#

+

Promise<DaemonSet>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.deployment/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.deployment/index.html new file mode 100644 index 0000000000..a3e1364255 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.deployment/index.html @@ -0,0 +1,1984 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Deployment - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Deployment#

+

Renderer.K8sApi.Deployment

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ Deployment

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Deployment(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
replicasnumber
selectorObject
selector.matchLabelsObject
strategyObject
strategy.rollingUpdateObject
strategy.rollingUpdate.maxSurgenumber
strategy.rollingUpdate.maxUnavailablenumber
strategy.typestring
templateObject
template.metadataObject
template.metadata.annotations?Object
template.metadata.creationTimestamp?string
template.metadata.labelsObject
template.specObject
template.spec.affinity?IAffinity
template.spec.containers{ args?: string[] ; env?: { name: string ; value: string }[] ; image: string ; imagePullPolicy: string ; livenessProbe?: IContainerProbe ; name: string ; ports?: { containerPort: number ; name: string ; protocol: string }[] ; readinessProbe?: IContainerProbe ; resources: { limits?: { cpu: string ; memory: string } ; requests: { cpu: string ; memory: string } } ; startupProbe?: IContainerProbe ; terminationMessagePath: string ; terminationMessagePolicy: string ; volumeMounts?: { mountPath: string ; name: string }[] }[]
template.spec.dnsPolicystring
template.spec.nodeSelector?Object
template.spec.restartPolicystring
template.spec.schedulerNamestring
template.spec.securityContextObject
template.spec.serviceAccountstring
template.spec.serviceAccountNamestring
template.spec.terminationGracePeriodSecondsnumber
template.spec.tolerations?{ effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]
template.spec.volumes?{ configMap: { defaultMode: number ; name: string ; optional: boolean } ; name: string }[]
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
availableReplicas?number
conditions{ lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]
observedGenerationnumber
readyReplicasnumber
replicasnumber
unavailableReplicas?number
updatedReplicasnumber
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/apps/v1/deployments"

+
+

kind#

+

▪ Static kind: string = "Deployment"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Inherited from#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getConditions#

+

▸ getConditions(activeOnly?): { lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
activeOnlybooleanfalse
+

Returns#

+

{ lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]

+
+

getConditionsText#

+

▸ getConditionsText(activeOnly?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
activeOnlybooleantrue
+

Returns#

+

string

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getReplicas#

+

▸ getReplicas(): number

+

Returns#

+

number

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): IToleration[]

+

Returns#

+

IToleration[]

+

Inherited from#

+

WorkloadKubeObject.getTolerations

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Deployment>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html new file mode 100644 index 0000000000..9756f8f912 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentapi/index.html @@ -0,0 +1,1778 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DeploymentApi#

+

Renderer.K8sApi.DeploymentApi

+

Hierarchy#

+ +

↳ DeploymentApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DeploymentApi(options)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<Deployment>
+

Inherited from#

+

KubeApi.constructor

+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+

Inherited from#

+

KubeApi.apiBase

+
+

apiGroup#

+

• Readonly apiGroup: string

+

Inherited from#

+

KubeApi.apiGroup

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+

Inherited from#

+

KubeApi.apiPrefix

+
+

apiResource#

+

• Readonly apiResource: string

+

Inherited from#

+

KubeApi.apiResource

+
+

apiVersion#

+

• Readonly apiVersion: string

+

Inherited from#

+

KubeApi.apiVersion

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+

Inherited from#

+

KubeApi.apiVersionPreferred

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+

Inherited from#

+

KubeApi.isNamespaced

+
+

kind#

+

• Readonly kind: string

+

Inherited from#

+

KubeApi.kind

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<Deployment>

+

Inherited from#

+

KubeApi.objectConstructor

+
+

options#

+

• Protected options: IKubeApiOptions<Deployment>

+

Inherited from#

+

KubeApi.options

+
+

request#

+

• Protected request: KubeJsonApi

+

Inherited from#

+

KubeApi.request

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+

Inherited from#

+

KubeApi.resourceVersions

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watchDisposer

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeApi.checkPreferredVersion

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeApi.create

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeApi.delete

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeApi.get

+
+

getReplicas#

+

▸ getReplicas(params): Promise<number>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
+

Returns#

+

Promise<number>

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getResourceVersion

+
+

getScaleApiUrl#

+

▸ Protected getScaleApiUrl(params): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
+

Returns#

+

string

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getUrl

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getWatchUrl

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<Deployment[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<Deployment[]>

+

Inherited from#

+

KubeApi.list

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+

Inherited from#

+

KubeApi.modifyWatchEvent

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+

Inherited from#

+

KubeApi.normalizeQuery

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): Deployment | Deployment[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

Deployment | Deployment[]

+

Inherited from#

+

KubeApi.parseResponse

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<Deployment[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<Deployment[]>

+

Inherited from#

+

KubeApi.refreshResourceVersion

+
+

restart#

+

▸ restart(params): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
+

Returns#

+

Promise<KubeJsonApiData>

+
+

scale#

+

▸ scale(params, replicas): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
replicasnumber
+

Returns#

+

Promise<KubeJsonApiData>

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+

Inherited from#

+

KubeApi.setResourceVersion

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeApi.update

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watch

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html new file mode 100644 index 0000000000..a84b3279d8 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html @@ -0,0 +1,2377 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DeploymentStore#

+

Renderer.K8sApi.DeploymentStore

+

Hierarchy#

+ +

↳ DeploymentStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new DeploymentStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: DeploymentApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Deployment>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Deployment, void, undefined>

+

Returns#

+

Generator<Deployment, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Deployment[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsDeployment[]
+

Returns#

+

Deployment[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Deployment[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Deployment[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Deployment

+

Parameters#

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

Returns#

+

Deployment

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Deployment[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Deployment[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Deployment

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Deployment

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Deployment

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Deployment

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getChildPods#

+

▸ getChildPods(deployment): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
deploymentDeployment
+

Returns#

+

Pod[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Deployment[]

+

Returns#

+

Deployment[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ getStatuses(deployments?): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
deployments?Deployment[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + +
NameType
failednumber
pendingnumber
runningnumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsDeployment[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Deployment[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Deployment[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Deployment[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Deployment>
+

Returns#

+

Promise<Deployment[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Deployment[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsDeployment[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Deployment[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDeployment
patchPatch
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Deployment[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Deployment[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDeployment
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items): Deployment[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsDeployment[]
+

Returns#

+

Deployment[]

+

Overrides#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsDeployment[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDeployment
dataPartial<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Deployment>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemDeployment
request() => Promise<Deployment>
+

Returns#

+

Promise<Deployment>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.endpoint/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.endpoint/index.html new file mode 100644 index 0000000000..dc70db41a9 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.endpoint/index.html @@ -0,0 +1,1704 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Endpoint - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Endpoint#

+

Renderer.K8sApi.Endpoint

+

Hierarchy#

+ +

↳ Endpoint

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Endpoint(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

subsets#

+

• subsets: IEndpointSubset[]

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/endpoints"

+
+

kind#

+

▪ Static kind: string = "Endpoints"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getEndpointSubsets#

+

▸ getEndpointSubsets(): EndpointSubset[]

+

Returns#

+

EndpointSubset[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

toString#

+

▸ toString(): string

+

Returns#

+

string

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Endpoint>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.endpointstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.endpointstore/index.html new file mode 100644 index 0000000000..79f928a8db --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.endpointstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: EndpointStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: EndpointStore#

+

Renderer.K8sApi.EndpointStore

+

Hierarchy#

+ +

↳ EndpointStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new EndpointStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<Endpoint>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<Endpoint>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Endpoint>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Endpoint, void, undefined>

+

Returns#

+

Generator<Endpoint, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Endpoint>
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Endpoint>
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Endpoint[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsEndpoint[]
+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Endpoint[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Endpoint

+

Parameters#

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

Returns#

+

Endpoint

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Endpoint[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Endpoint

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Endpoint

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Endpoint

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Endpoint

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Endpoint[]

+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsEndpoint[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsEndpoint[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Endpoint[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Endpoint[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Endpoint[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Endpoint>
+

Returns#

+

Promise<Endpoint[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Endpoint[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsEndpoint[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemEndpoint
patchPatch
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Endpoint[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Endpoint[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemEndpoint
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Endpoint[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsEndpoint[]the items to be sorted (default: the current items in this store)
sorting(item: Endpoint) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Endpoint[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsEndpoint[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemEndpoint
dataPartial<Endpoint>
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Endpoint>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemEndpoint
request() => Promise<Endpoint>
+

Returns#

+

Promise<Endpoint>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.eventstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.eventstore/index.html new file mode 100644 index 0000000000..ec655032a4 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.eventstore/index.html @@ -0,0 +1,2375 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: EventStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: EventStore#

+

Renderer.K8sApi.EventStore

+

Hierarchy#

+ +

↳ EventStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new EventStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<KubeEvent>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<KubeEvent>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• limit: number = 1000

+

Overrides#

+

KubeObjectStore.limit

+
+

saveLimit#

+

• saveLimit: number = 50000

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<KubeEvent, void, undefined>

+

Returns#

+

Generator<KubeEvent, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(): void

+

Returns#

+

void

+

Overrides#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<KubeEvent>
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<KubeEvent>
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): KubeEvent[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsKubeEvent[]
+

Returns#

+

KubeEvent[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): KubeEvent[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

KubeEvent[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): KubeEvent

+

Parameters#

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

Returns#

+

KubeEvent

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): KubeEvent[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

KubeEvent[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): KubeEvent

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

KubeEvent

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): KubeEvent

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

KubeEvent

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getEventsByObject#

+

▸ getEventsByObject(obj): KubeEvent[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
objKubeObject<KubeObjectMetadata, any, any>
+

Returns#

+

KubeEvent[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): KubeEvent[]

+

Returns#

+

KubeEvent[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsKubeEvent[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

getWarnings#

+

▸ getWarnings(): KubeEvent[]

+

Returns#

+

KubeEvent[]

+
+

getWarningsCount#

+

▸ getWarningsCount(): number

+

Returns#

+

number

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsKubeEvent[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | KubeEvent[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | KubeEvent[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<KubeEvent[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<KubeEvent>
+

Returns#

+

Promise<KubeEvent[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): KubeEvent[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsKubeEvent[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

KubeEvent[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemKubeEvent
patchPatch
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | KubeEvent[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | KubeEvent[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemKubeEvent
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items): KubeEvent[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsKubeEvent[]
+

Returns#

+

KubeEvent[]

+

Overrides#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsKubeEvent[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemKubeEvent
dataPartial<KubeEvent>
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<KubeEvent>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemKubeEvent
request() => Promise<KubeEvent>
+

Returns#

+

Promise<KubeEvent>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html new file mode 100644 index 0000000000..72ba37c1f0 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/index.html @@ -0,0 +1,1867 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: HorizontalPodAutoscaler - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: HorizontalPodAutoscaler#

+

Renderer.K8sApi.HorizontalPodAutoscaler

+

Hierarchy#

+ +

↳ HorizontalPodAutoscaler

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new HorizontalPodAutoscaler(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
maxReplicasnumber
metricsIHpaMetric[]
minReplicasnumber
scaleTargetRefObject
scaleTargetRef.apiVersionstring
scaleTargetRef.kindstring
scaleTargetRef.namestring
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
conditions{ lastTransitionTime: string ; message: string ; reason: string ; status: string ; type: string }[]
currentMetricsIHpaMetric[]
currentReplicasnumber
desiredReplicasnumber
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/autoscaling/v2beta1/horizontalpodautoscalers"

+
+

kind#

+

▪ Static kind: string = "HorizontalPodAutoscaler"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getConditions#

+

▸ getConditions(): { isReady: boolean ; lastTransitionTime: string ; message: string ; reason: string ; status: string ; tooltip: string ; type: string }[]

+

Returns#

+

{ isReady: boolean ; lastTransitionTime: string ; message: string ; reason: string ; status: string ; tooltip: string ; type: string }[]

+
+

getCurrentMetrics#

+

▸ getCurrentMetrics(): IHpaMetric[]

+

Returns#

+

IHpaMetric[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getMaxPods#

+

▸ getMaxPods(): number

+

Returns#

+

number

+
+

getMetricName#

+

▸ Protected getMetricName(metric): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
metricIHpaMetric
+

Returns#

+

string

+
+

getMetricValues#

+

▸ getMetricValues(metric): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
metricIHpaMetric
+

Returns#

+

string

+
+

getMetrics#

+

▸ getMetrics(): IHpaMetric[]

+

Returns#

+

IHpaMetric[]

+
+

getMinPods#

+

▸ getMinPods(): number

+

Returns#

+

number

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getReplicas#

+

▸ getReplicas(): number

+

Returns#

+

number

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<HorizontalPodAutoscaler>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.hpastore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.hpastore/index.html new file mode 100644 index 0000000000..9da33bfdce --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.hpastore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: HPAStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: HPAStore#

+

Renderer.K8sApi.HPAStore

+

Hierarchy#

+ +

↳ HPAStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new HPAStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<HorizontalPodAutoscaler>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<HorizontalPodAutoscaler>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<HorizontalPodAutoscaler, void, undefined>

+

Returns#

+

Generator<HorizontalPodAutoscaler, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<HorizontalPodAutoscaler>
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<HorizontalPodAutoscaler>
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): HorizontalPodAutoscaler[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsHorizontalPodAutoscaler[]
+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): HorizontalPodAutoscaler[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): HorizontalPodAutoscaler

+

Parameters#

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

Returns#

+

HorizontalPodAutoscaler

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): HorizontalPodAutoscaler[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): HorizontalPodAutoscaler

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

HorizontalPodAutoscaler

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): HorizontalPodAutoscaler

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

HorizontalPodAutoscaler

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): HorizontalPodAutoscaler[]

+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsHorizontalPodAutoscaler[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsHorizontalPodAutoscaler[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | HorizontalPodAutoscaler[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | HorizontalPodAutoscaler[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<HorizontalPodAutoscaler[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<HorizontalPodAutoscaler>
+

Returns#

+

Promise<HorizontalPodAutoscaler[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): HorizontalPodAutoscaler[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsHorizontalPodAutoscaler[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
patchPatch
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | HorizontalPodAutoscaler[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | HorizontalPodAutoscaler[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): HorizontalPodAutoscaler[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsHorizontalPodAutoscaler[]the items to be sorted (default: the current items in this store)
sorting(item: HorizontalPodAutoscaler) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

HorizontalPodAutoscaler[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsHorizontalPodAutoscaler[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
dataPartial<HorizontalPodAutoscaler>
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<HorizontalPodAutoscaler>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
request() => Promise<HorizontalPodAutoscaler>
+

Returns#

+

Promise<HorizontalPodAutoscaler>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.ingress/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingress/index.html new file mode 100644 index 0000000000..df14802271 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingress/index.html @@ -0,0 +1,1796 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Ingress - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Ingress#

+

Renderer.K8sApi.Ingress

+

Hierarchy#

+ +

↳ Ingress

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Ingress(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
backend?IExtensionsBackend
defaultBackend?INetworkingBackend & { resource: { apiGroup: string ; kind: string ; name: string } }
rules?{ host?: string ; http: { paths: { backend: IIngressBackend ; path?: string }[] } }[]
tls{ secretName: string }[]
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
loadBalancerObject
loadBalancer.ingressILoadBalancerIngress[]
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/networking.k8s.io/v1/ingresses"

+
+

kind#

+

▪ Static kind: string = "Ingress"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getHosts#

+

▸ getHosts(): string[]

+

Returns#

+

string[]

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getLoadBalancers#

+

▸ getLoadBalancers(): string[]

+

Returns#

+

string[]

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getPorts#

+

▸ getPorts(): string

+

Returns#

+

string

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getRoutes#

+

▸ getRoutes(): string[]

+

Returns#

+

string[]

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getServiceNamePort#

+

▸ getServiceNamePort(): Object

+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
serviceNamestring
servicePortstring | number
+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Ingress>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressapi/index.html new file mode 100644 index 0000000000..d44571d911 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressapi/index.html @@ -0,0 +1,1630 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: IngressApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: IngressApi#

+

Renderer.K8sApi.IngressApi

+

Hierarchy#

+ +

↳ IngressApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new IngressApi(options)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<Ingress>
+

Inherited from#

+

KubeApi.constructor

+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+

Inherited from#

+

KubeApi.apiBase

+
+

apiGroup#

+

• Readonly apiGroup: string

+

Inherited from#

+

KubeApi.apiGroup

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+

Inherited from#

+

KubeApi.apiPrefix

+
+

apiResource#

+

• Readonly apiResource: string

+

Inherited from#

+

KubeApi.apiResource

+
+

apiVersion#

+

• Readonly apiVersion: string

+

Inherited from#

+

KubeApi.apiVersion

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+

Inherited from#

+

KubeApi.apiVersionPreferred

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+

Inherited from#

+

KubeApi.isNamespaced

+
+

kind#

+

• Readonly kind: string

+

Inherited from#

+

KubeApi.kind

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<Ingress>

+

Inherited from#

+

KubeApi.objectConstructor

+
+

options#

+

• Protected options: IKubeApiOptions<Ingress>

+

Inherited from#

+

KubeApi.options

+
+

request#

+

• Protected request: KubeJsonApi

+

Inherited from#

+

KubeApi.request

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+

Inherited from#

+

KubeApi.resourceVersions

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watchDisposer

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeApi.checkPreferredVersion

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeApi.create

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeApi.delete

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeApi.get

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getResourceVersion

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getUrl

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getWatchUrl

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<Ingress[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<Ingress[]>

+

Inherited from#

+

KubeApi.list

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+

Inherited from#

+

KubeApi.modifyWatchEvent

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+

Inherited from#

+

KubeApi.normalizeQuery

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): Ingress | Ingress[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

Ingress | Ingress[]

+

Inherited from#

+

KubeApi.parseResponse

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<Ingress[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<Ingress[]>

+

Inherited from#

+

KubeApi.refreshResourceVersion

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+

Inherited from#

+

KubeApi.setResourceVersion

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeApi.update

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watch

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressstore/index.html new file mode 100644 index 0000000000..9e45d42c1a --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: IngressStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: IngressStore#

+

Renderer.K8sApi.IngressStore

+

Hierarchy#

+ +

↳ IngressStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new IngressStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<Ingress>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: IngressApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Ingress>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Ingress, void, undefined>

+

Returns#

+

Generator<Ingress, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Ingress[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsIngress[]
+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Ingress[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Ingress

+

Parameters#

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

Returns#

+

Ingress

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Ingress[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Ingress

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Ingress

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Ingress

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Ingress

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Ingress[]

+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsIngress[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsIngress[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Ingress[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Ingress[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Ingress[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Ingress>
+

Returns#

+

Promise<Ingress[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Ingress[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsIngress[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemIngress
patchPatch
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Ingress[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Ingress[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemIngress
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Ingress[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsIngress[]the items to be sorted (default: the current items in this store)
sorting(item: Ingress) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Ingress[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsIngress[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemIngress
dataPartial<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Ingress>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemIngress
request() => Promise<Ingress>
+

Returns#

+

Promise<Ingress>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.job/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.job/index.html new file mode 100644 index 0000000000..ecdba47e3a --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.job/index.html @@ -0,0 +1,1983 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Job - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Job#

+

Renderer.K8sApi.Job

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ Job

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Job(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
backoffLimit?number
completions?number
containers?IPodContainer[]
dnsPolicy?string
parallelism?number
restartPolicy?string
schedulerName?string
selector?Object
selector.matchLabelsObject
serviceAccount?string
serviceAccountName?string
templateObject
template.metadataObject
template.metadata.annotations?Object
template.metadata.creationTimestamp?string
template.metadata.labels?Object
template.specObject
template.spec.affinity?IAffinity
template.spec.containersIPodContainer[]
template.spec.dnsPolicystring
template.spec.hostPIDboolean
template.spec.nodeSelector?Object
template.spec.restartPolicystring
template.spec.schedulerNamestring
template.spec.terminationGracePeriodSecondsnumber
template.spec.tolerations?{ effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]
terminationGracePeriodSeconds?number
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
completionTimestring
conditions{ lastProbeTime: string ; lastTransitionTime: string ; message?: string ; status: string ; type: string }[]
startTimestring
succeedednumber
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/batch/v1/jobs"

+
+

kind#

+

▪ Static kind: string = "Job"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(): Promise<KubeJsonApiData>

+

Returns#

+

Promise<KubeJsonApiData>

+

Overrides#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Inherited from#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getCompletions#

+

▸ getCompletions(): number

+

Returns#

+

number

+
+

getCondition#

+

▸ getCondition(): Object

+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
lastProbeTimestring
lastTransitionTimestring
message?string
statusstring
typestring
+
+

getDesiredCompletions#

+

▸ getDesiredCompletions(): number

+

Returns#

+

number

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getImages#

+

▸ getImages(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getParallelism#

+

▸ getParallelism(): number

+

Returns#

+

number

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): IToleration[]

+

Returns#

+

IToleration[]

+

Inherited from#

+

WorkloadKubeObject.getTolerations

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Job>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.jobstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.jobstore/index.html new file mode 100644 index 0000000000..257caf45ad --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.jobstore/index.html @@ -0,0 +1,2421 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: JobStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: JobStore#

+

Renderer.K8sApi.JobStore

+

Hierarchy#

+ +

↳ JobStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new JobStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: JobApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Job>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Job, void, undefined>

+

Returns#

+

Generator<Job, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Job>
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Job>
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Job[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsJob[]
+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Job[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Job

+

Parameters#

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

Returns#

+

Job

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Job[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Job

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Job

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Job

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Job

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getChildPods#

+

▸ getChildPods(job): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
jobJob
+

Returns#

+

Pod[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Job[]

+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getJobsByOwner#

+

▸ getJobsByOwner(cronJob): Job[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
cronJobCronJob
+

Returns#

+

Job[]

+
+

getStatuses#

+

▸ getStatuses(jobs?): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
jobs?Job[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
failednumber
pendingnumber
runningnumber
succeedednumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsJob[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Job[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Job[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Job[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Job>
+

Returns#

+

Promise<Job[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Job[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsJob[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemJob
patchPatch
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Job[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Job[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemJob
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Job[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsJob[]the items to be sorted (default: the current items in this store)
sorting(item: Job) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Job[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsJob[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemJob
dataPartial<Job>
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Job>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemJob
request() => Promise<Job>
+

Returns#

+

Promise<Job>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeapi/index.html new file mode 100644 index 0000000000..55682e142b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeapi/index.html @@ -0,0 +1,1613 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeApi<T>#

+

Renderer.K8sApi.KubeApi

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject
+

Hierarchy#

+
    +
  • KubeApi
    • +
+

↳ PodsApi

+

↳ NodesApi

+

↳ DeploymentApi

+

↳ IngressApi

+

↳ PersistentVolumeClaimsApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeApi<T>(options)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject<KubeObjectMetadata, any, any, T>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<T>
+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+
+

apiGroup#

+

• Readonly apiGroup: string

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+
+

apiResource#

+

• Readonly apiResource: string

+
+

apiVersion#

+

• Readonly apiVersion: string

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+
+

kind#

+

• Readonly kind: string

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<T>

+
+

options#

+

• Protected options: IKubeApiOptions<T>

+
+

request#

+

• Protected request: KubeJsonApi

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<T>
+

Returns#

+

Promise<T>

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<T>

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<T[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<T[]>

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): T | T[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

T | T[]

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<T[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<T[]>

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<T>
+

Returns#

+

Promise<T>

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeevent/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeevent/index.html new file mode 100644 index 0000000000..8e5c4614c5 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeevent/index.html @@ -0,0 +1,1898 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeEvent - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeEvent#

+

Renderer.K8sApi.KubeEvent

+

Hierarchy#

+ +

↳ KubeEvent

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeEvent(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

count#

+

• count: number

+
+

eventTime#

+

• eventTime: null

+
+

firstTimestamp#

+

• firstTimestamp: string

+
+

involvedObject#

+

• involvedObject: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
apiVersionstring
fieldPathstring
kindstring
namestring
namespacestring
resourceVersionstring
uidstring
+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

lastTimestamp#

+

• lastTimestamp: string

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

message#

+

• message: string

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

reason#

+

• reason: string

+
+

reportingComponent#

+

• reportingComponent: string

+
+

reportingInstance#

+

• reportingInstance: string

+
+

source#

+

• source: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
componentstring
hoststring
+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

type#

+

• type: string

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/events"

+
+

kind#

+

▪ Static kind: string = "Event"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getFirstSeenTime#

+

▸ getFirstSeenTime(): string

+

Returns#

+

string

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getLastSeenTime#

+

▸ getLastSeenTime(): string

+

Returns#

+

string

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSource#

+

▸ getSource(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

isWarning#

+

▸ isWarning(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<KubeEvent>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobject/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobject/index.html new file mode 100644 index 0000000000..999d1ba36b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobject/index.html @@ -0,0 +1,1680 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObject - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObject<Metadata, Status, Spec>#

+

Renderer.K8sApi.KubeObject

+

Type parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
MetadataMetadata: KubeObjectMetadata = KubeObjectMetadata
StatusStatus = any
SpecSpec = any
+

Hierarchy#

+
    +
  • KubeObject
    • +
+

↳ Node

+

↳ CronJob

+

↳ ConfigMap

+

↳ Secret

+

↳ ResourceQuota

+

↳ LimitRange

+

↳ HorizontalPodAutoscaler

+

↳ PodDisruptionBudget

+

↳ Service

+

↳ Endpoint

+

↳ Ingress

+

↳ NetworkPolicy

+

↳ PersistentVolume

+

↳ PersistentVolumeClaim

+

↳ StorageClass

+

↳ Namespace

+

↳ KubeEvent

+

↳ ServiceAccount

+

↳ Role

+

↳ RoleBinding

+

↳ ClusterRole

+

↳ ClusterRoleBinding

+

↳ CustomResourceDefinition

+

Implements#

+
    +
  • ItemObject
    • +
+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObject<Metadata, Status, Spec>(data)

+

Type parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
MetadataMetadata: KubeObjectMetadata = KubeObjectMetadata
StatusStatus = any
SpecSpec = any
+

Parameters#

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

Properties#

+

apiVersion#

+

• apiVersion: string

+
+

kind#

+

• kind: string

+
+

managedFields#

+

• Optional managedFields: any

+
+

metadata#

+

• metadata: Metadata

+
+

spec#

+

• Optional spec: Spec

+
+

status#

+

• Optional status: Status

+
+

kind#

+

▪ Static Readonly kind: string

+
+

namespaced#

+

▪ Static Readonly namespaced: boolean

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Implementation of#

+

ItemObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Implementation of#

+

ItemObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<KubeObject<Metadata, Status, Spec>>
+

Returns#

+

Promise<KubeJsonApiData>

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html new file mode 100644 index 0000000000..64b0a31c5c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobjectstore/index.html @@ -0,0 +1,2373 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: KubeObjectStore<T>#

+

Renderer.K8sApi.KubeObjectStore

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: 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

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new KubeObjectStore<T>(api?)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject<KubeObjectMetadata, any, any, T>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<T>
+

Overrides#

+

ItemStore<T\>.constructor

+

Properties#

+

api#

+

• api: KubeApi<T>

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

ItemStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

ItemStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

ItemStore.isLoading

+
+

items#

+

• items: IObservableArray<T>

+

Inherited from#

+

ItemStore.items

+
+

limit#

+

• Optional Readonly limit: number

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

ItemStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<T, void, undefined>

+

Returns#

+

Generator<T, void, undefined>

+

Inherited from#

+

ItemStore.__@iterator@599

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+
+

create#

+

▸ create(params, data?): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<T>
+

Returns#

+

Promise<T>

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<T>
+

Returns#

+

Promise<T>

+

Overrides#

+

ItemStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

ItemStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): T[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsT[]
+

Returns#

+

T[]

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): T[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

T[]

+
+

getById#

+

▸ getById(id): T

+

Parameters#

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

Returns#

+

T

+
+

getByLabel#

+

▸ getByLabel(labels): T[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

T[]

+
+

getByName#

+

▸ getByName(name, namespace?): T

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

T

+

Overrides#

+

ItemStore.getByName

+
+

getByPath#

+

▸ getByPath(path): T

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

T

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

ItemStore.getIndexById

+
+

getItems#

+

▸ getItems(): T[]

+

Returns#

+

T[]

+

Inherited from#

+

ItemStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsT[]
+

Returns#

+

Record<string, number>

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Overrides#

+

ItemStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

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

Returns#

+

boolean

+

Inherited from#

+

ItemStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsT[]
+

Returns#

+

boolean

+

Inherited from#

+

ItemStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<T>

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | T[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | T[]>

+

Overrides#

+

ItemStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<T>

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<T>

+

Overrides#

+

ItemStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<T[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<T>
+

Returns#

+

Promise<T[]>

+

Overrides#

+

ItemStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): T[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsT[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

T[]

+
+

patch#

+

▸ patch(item, patch): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemT
patchPatch
+

Returns#

+

Promise<T>

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | T[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | T[]>

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemT
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

ItemStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Overrides#

+

ItemStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

ItemStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

ItemStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

ItemStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): T[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsT[]the items to be sorted (default: the current items in this store)
sorting(item: T) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

T[]

+

Inherited from#

+

ItemStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

ItemStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsT[]
+

Returns#

+

void

+

Inherited from#

+

ItemStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

ItemStore.unselect

+
+

update#

+

▸ update(item, data): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemT
dataPartial<T>
+

Returns#

+

Promise<T>

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<T>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemT
request() => Promise<T>
+

Returns#

+

Promise<T>

+

Inherited from#

+

ItemStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrange/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrange/index.html new file mode 100644 index 0000000000..9e274b18e0 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrange/index.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LimitRange - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LimitRange#

+

Renderer.K8sApi.LimitRange

+

Hierarchy#

+ +

↳ LimitRange

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new LimitRange(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
limitsLimitRangeItem[]
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/limitranges"

+
+

kind#

+

▪ Static kind: string = "LimitRange"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getContainerLimits#

+

▸ getContainerLimits(): LimitRangeItem[]

+

Returns#

+

LimitRangeItem[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getPVCLimits#

+

▸ getPVCLimits(): LimitRangeItem[]

+

Returns#

+

LimitRangeItem[]

+
+

getPodLimits#

+

▸ getPodLimits(): LimitRangeItem[]

+

Returns#

+

LimitRangeItem[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<LimitRange>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html new file mode 100644 index 0000000000..2fa49bd92e --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LimitRangesStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LimitRangesStore#

+

Renderer.K8sApi.LimitRangesStore

+

Hierarchy#

+ +

↳ LimitRangesStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new LimitRangesStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<LimitRange>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<LimitRange>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<LimitRange>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<LimitRange, void, undefined>

+

Returns#

+

Generator<LimitRange, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<LimitRange>
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<LimitRange>
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): LimitRange[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsLimitRange[]
+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): LimitRange[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): LimitRange

+

Parameters#

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

Returns#

+

LimitRange

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): LimitRange[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): LimitRange

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

LimitRange

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): LimitRange

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

LimitRange

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): LimitRange[]

+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsLimitRange[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsLimitRange[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | LimitRange[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | LimitRange[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<LimitRange[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<LimitRange>
+

Returns#

+

Promise<LimitRange[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): LimitRange[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsLimitRange[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemLimitRange
patchPatch
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | LimitRange[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | LimitRange[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemLimitRange
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): LimitRange[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsLimitRange[]the items to be sorted (default: the current items in this store)
sorting(item: LimitRange) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

LimitRange[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsLimitRange[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemLimitRange
dataPartial<LimitRange>
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<LimitRange>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemLimitRange
request() => Promise<LimitRange>
+

Returns#

+

Promise<LimitRange>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.namespace/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.namespace/index.html new file mode 100644 index 0000000000..ac8bd90060 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.namespace/index.html @@ -0,0 +1,1695 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Namespace - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Namespace#

+

Renderer.K8sApi.Namespace

+

Hierarchy#

+ +

↳ Namespace

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Namespace(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
phasestring
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/namespaces"

+
+

kind#

+

▪ Static kind: string = "Namespace"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getStatus#

+

▸ getStatus(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Namespace>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.namespacestore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.namespacestore/index.html new file mode 100644 index 0000000000..751f8c9445 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.namespacestore/index.html @@ -0,0 +1,2622 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NamespaceStore#

+

Renderer.K8sApi.NamespaceStore

+

Hierarchy#

+ +

↳ NamespaceStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NamespaceStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: NamespaceApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Namespace>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

allowedNamespaces#

+

• get allowedNamespaces(): string[]

+

Returns#

+

string[]

+
+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextNamespaces#

+

• get contextNamespaces(): string[]

+

Returns#

+

string[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

hasAllContexts#

+

• get hasAllContexts(): boolean

+

Returns#

+

boolean

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+
+

selectedNamespaces#

+

• get selectedNamespaces(): string[]

+

Returns#

+

string[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Namespace, void, undefined>

+

Returns#

+

Generator<Namespace, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

clearSelected#

+

▸ clearSelected(namespaces?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespaces?string | string[]
+

Returns#

+

void

+
+

create#

+

▸ create(params, data?): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Namespace>
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Namespace>
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Namespace[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNamespace[]
+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Namespace[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Namespace

+

Parameters#

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

Returns#

+

Namespace

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Namespace[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Namespace

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Namespace

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Namespace

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Namespace

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Namespace[]

+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNamespace[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

hasContext#

+

▸ hasContext(namespaces): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespacesstring | string[]
+

Returns#

+

boolean

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNamespace[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Namespace[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Namespace[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(params): Promise<Namespace[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
paramsKubeObjectStoreLoadingParams<Namespace>
+

Returns#

+

Promise<Namespace[]>

+

Overrides#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Namespace[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsNamespace[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

onContextChange#

+

▸ onContextChange(callback, opts?): IReactionDisposer

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
callback(namespaces: string[]) => void
optsIReactionOptions
+

Returns#

+

IReactionDisposer

+
+

patch#

+

▸ patch(item, patch): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNamespace
patchPatch
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Namespace[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Namespace[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns#

+

Promise<void>

+

Overrides#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNamespace
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

selectNamespaces#

+

▸ selectNamespaces(namespace): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespacestring | string[]
+

Returns#

+

void

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Namespace[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsNamespace[]the items to be sorted (default: the current items in this store)
sorting(item: Namespace) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Namespace[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): (...args: T) => void

+

Returns#

+

fn

+

▸ <T>(...args): void

+

A function that does nothing

+
Type parameters#
+ + + + + + + + + + + + + +
NameType
TT: any[]
+
Parameters#
+ + + + + + + + + + + + + +
NameType
...argsT
+
Returns#
+

void

+

Overrides#

+

KubeObjectStore.subscribe

+
+

toggleAll#

+

▸ toggleAll(showAll?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
showAll?boolean
+

Returns#

+

void

+
+

toggleContext#

+

▸ toggleContext(namespaces): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespacesstring | string[]
+

Returns#

+

void

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNamespace[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

toggleSingle#

+

▸ toggleSingle(namespace): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespacestring
+

Returns#

+

void

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNamespace
dataPartial<Namespace>
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Namespace>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNamespace
request() => Promise<Namespace>
+

Returns#

+

Promise<Namespace>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html new file mode 100644 index 0000000000..e6a68b1756 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicy/index.html @@ -0,0 +1,1728 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicy - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NetworkPolicy#

+

Renderer.K8sApi.NetworkPolicy

+

Hierarchy#

+ +

↳ NetworkPolicy

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NetworkPolicy(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
egressIPolicyEgress[]
ingressIPolicyIngress[]
podSelectorObject
podSelector.matchLabelsObject
podSelector.matchLabels.rolestring
policyTypesstring[]
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/networking.k8s.io/v1/networkpolicies"

+
+

kind#

+

▪ Static kind: string = "NetworkPolicy"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getMatchLabels#

+

▸ getMatchLabels(): string[]

+

Returns#

+

string[]

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getTypes#

+

▸ getTypes(): string[]

+

Returns#

+

string[]

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<NetworkPolicy>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html new file mode 100644 index 0000000000..e06ec4f805 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicyStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NetworkPolicyStore#

+

Renderer.K8sApi.NetworkPolicyStore

+

Hierarchy#

+ +

↳ NetworkPolicyStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NetworkPolicyStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<NetworkPolicy>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<NetworkPolicy>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<NetworkPolicy, void, undefined>

+

Returns#

+

Generator<NetworkPolicy, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<NetworkPolicy>
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<NetworkPolicy>
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): NetworkPolicy[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNetworkPolicy[]
+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): NetworkPolicy[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): NetworkPolicy

+

Parameters#

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

Returns#

+

NetworkPolicy

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): NetworkPolicy[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): NetworkPolicy

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

NetworkPolicy

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): NetworkPolicy

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

NetworkPolicy

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): NetworkPolicy[]

+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNetworkPolicy[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNetworkPolicy[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | NetworkPolicy[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | NetworkPolicy[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<NetworkPolicy[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<NetworkPolicy>
+

Returns#

+

Promise<NetworkPolicy[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): NetworkPolicy[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsNetworkPolicy[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNetworkPolicy
patchPatch
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | NetworkPolicy[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | NetworkPolicy[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNetworkPolicy
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): NetworkPolicy[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsNetworkPolicy[]the items to be sorted (default: the current items in this store)
sorting(item: NetworkPolicy) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

NetworkPolicy[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNetworkPolicy[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNetworkPolicy
dataPartial<NetworkPolicy>
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<NetworkPolicy>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNetworkPolicy
request() => Promise<NetworkPolicy>
+

Returns#

+

Promise<NetworkPolicy>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.node/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.node/index.html new file mode 100644 index 0000000000..ab89e675ae --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.node/index.html @@ -0,0 +1,1988 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Node - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Node#

+

Renderer.K8sApi.Node

+

Hierarchy#

+ +

↳ Node

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Node(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
externalID?string
podCIDR?string
podCIDRs?string[]
providerID?string
taints?{ effect: string ; key: string ; timeAdded: string ; value: string }[]
unschedulable?boolean
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
addresses?{ address: string ; type: string }[]
allocatable?Object
allocatable.cpustring
allocatable.ephemeral-storagestring
allocatable.hugepages-1Gistring
allocatable.hugepages-2Mistring
allocatable.memorystring
allocatable.podsstring
capacity?Object
capacity.cpustring
capacity.ephemeral-storagestring
capacity.hugepages-1Gistring
capacity.hugepages-2Mistring
capacity.memorystring
capacity.podsstring
conditions?{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]
daemonEndpoints?Object
daemonEndpoints.kubeletEndpointObject
daemonEndpoints.kubeletEndpoint.Portnumber
images?{ names: string[] ; sizeBytes?: number }[]
nodeInfo?Object
nodeInfo.architecturestring
nodeInfo.bootIDstring
nodeInfo.containerRuntimeVersionstring
nodeInfo.kernelVersionstring
nodeInfo.kubeProxyVersionstring
nodeInfo.kubeletVersionstring
nodeInfo.machineIDstring
nodeInfo.operatingSystemstring
nodeInfo.osImagestring
nodeInfo.systemUUIDstring
volumesAttached?{ devicePath: string ; name: string }[]
volumesInUse?string[]
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/nodes"

+
+

kind#

+

▪ Static kind: string = "Node"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getActiveConditions#

+

▸ getActiveConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+

Returns#

+

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getConditions#

+

▸ getConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+

Returns#

+

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+
+

getCpuCapacity#

+

▸ getCpuCapacity(): number

+

Returns#

+

number

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getKubeletVersion#

+

▸ getKubeletVersion(): string

+

Returns#

+

string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getMemoryCapacity#

+

▸ getMemoryCapacity(): number

+

Returns#

+

number

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNodeConditionText#

+

▸ getNodeConditionText(): string

+

Returns#

+

string

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOperatingSystem#

+

▸ getOperatingSystem(): string

+

Returns#

+

string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getRoleLabels#

+

▸ getRoleLabels(): string

+

Returns#

+

string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTaints#

+

▸ getTaints(): { effect: string ; key: string ; timeAdded: string ; value: string }[]

+

Returns#

+

{ effect: string ; key: string ; timeAdded: string ; value: string }[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getWarningConditions#

+

▸ getWarningConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+

Returns#

+

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

+
+

isUnschedulable#

+

▸ isUnschedulable(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Node>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesapi/index.html new file mode 100644 index 0000000000..b0a7f82975 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesapi/index.html @@ -0,0 +1,1630 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NodesApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NodesApi#

+

Renderer.K8sApi.NodesApi

+

Hierarchy#

+ +

↳ NodesApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NodesApi(options)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<Node>
+

Inherited from#

+

KubeApi.constructor

+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+

Inherited from#

+

KubeApi.apiBase

+
+

apiGroup#

+

• Readonly apiGroup: string

+

Inherited from#

+

KubeApi.apiGroup

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+

Inherited from#

+

KubeApi.apiPrefix

+
+

apiResource#

+

• Readonly apiResource: string

+

Inherited from#

+

KubeApi.apiResource

+
+

apiVersion#

+

• Readonly apiVersion: string

+

Inherited from#

+

KubeApi.apiVersion

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+

Inherited from#

+

KubeApi.apiVersionPreferred

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+

Inherited from#

+

KubeApi.isNamespaced

+
+

kind#

+

• Readonly kind: string

+

Inherited from#

+

KubeApi.kind

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<Node>

+

Inherited from#

+

KubeApi.objectConstructor

+
+

options#

+

• Protected options: IKubeApiOptions<Node>

+

Inherited from#

+

KubeApi.options

+
+

request#

+

• Protected request: KubeJsonApi

+

Inherited from#

+

KubeApi.request

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+

Inherited from#

+

KubeApi.resourceVersions

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watchDisposer

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeApi.checkPreferredVersion

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeApi.create

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeApi.delete

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeApi.get

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getResourceVersion

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getUrl

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getWatchUrl

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<Node[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<Node[]>

+

Inherited from#

+

KubeApi.list

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+

Inherited from#

+

KubeApi.modifyWatchEvent

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+

Inherited from#

+

KubeApi.normalizeQuery

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): Node | Node[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

Node | Node[]

+

Inherited from#

+

KubeApi.parseResponse

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<Node[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<Node[]>

+

Inherited from#

+

KubeApi.refreshResourceVersion

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+

Inherited from#

+

KubeApi.setResourceVersion

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeApi.update

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watch

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesstore/index.html new file mode 100644 index 0000000000..1486c2ed2b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesstore/index.html @@ -0,0 +1,2378 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NodesStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NodesStore#

+

Renderer.K8sApi.NodesStore

+

Hierarchy#

+ +

↳ NodesStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new NodesStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: NodesApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Node>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

masterNodes#

+

• get masterNodes(): Node[]

+

Returns#

+

Node[]

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+
+

workerNodes#

+

• get workerNodes(): Node[]

+

Returns#

+

Node[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Node, void, undefined>

+

Returns#

+

Generator<Node, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Node[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNode[]
+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Node[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Node

+

Parameters#

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

Returns#

+

Node

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Node[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Node

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Node

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Node

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Node

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Node[]

+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsNode[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

getWarningsCount#

+

▸ getWarningsCount(): number

+

Returns#

+

number

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNode[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Node[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Node[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Node[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Node>
+

Returns#

+

Promise<Node[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Node[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsNode[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNode
patchPatch
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Node[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Node[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNode
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Node[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsNode[]the items to be sorted (default: the current items in this store)
sorting(item: Node) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Node[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsNode[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNode
dataPartial<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Node>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemNode
request() => Promise<Node>
+

Returns#

+

Promise<Node>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html new file mode 100644 index 0000000000..d76127919c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolume/index.html @@ -0,0 +1,1871 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolume - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PersistentVolume#

+

Renderer.K8sApi.PersistentVolume

+

Hierarchy#

+ +

↳ PersistentVolume

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PersistentVolume(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
accessModesstring[]
capacityObject
capacity.storagestring
claimRefObject
claimRef.apiVersionstring
claimRef.kindstring
claimRef.namestring
claimRef.namespacestring
claimRef.resourceVersionstring
claimRef.uidstring
flexVolumeObject
flexVolume.driverstring
flexVolume.optionsObject
flexVolume.options.clusterNamespacestring
flexVolume.options.imagestring
flexVolume.options.poolstring
flexVolume.options.storageClassstring
mountOptions?string[]
nfs?Object
nfs.pathstring
nfs.serverstring
persistentVolumeReclaimPolicystring
storageClassNamestring
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
phasestring
reason?string
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/persistentvolumes"

+
+

kind#

+

▪ Static kind: string = "PersistentVolume"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getCapacity#

+

▸ getCapacity(inBytes?): string | number

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
inBytesbooleanfalse
+

Returns#

+

string | number

+
+

getClaimRefName#

+

▸ getClaimRefName(): string

+

Returns#

+

string

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getStatus#

+

▸ getStatus(): string

+

Returns#

+

string

+
+

getStorageClass#

+

▸ getStorageClass(): string

+

Returns#

+

string

+
+

getStorageClassName#

+

▸ getStorageClassName(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<PersistentVolume>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html new file mode 100644 index 0000000000..d0c31d08be --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/index.html @@ -0,0 +1,1809 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaim - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PersistentVolumeClaim#

+

Renderer.K8sApi.PersistentVolumeClaim

+

Hierarchy#

+ +

↳ PersistentVolumeClaim

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PersistentVolumeClaim(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
accessModesstring[]
resourcesObject
resources.requestsObject
resources.requests.storagestring
selectorObject
selector.matchExpressions{ key: string ; operator: string ; values: string[] }[]
selector.matchLabelsObject
selector.matchLabels.releasestring
storageClassNamestring
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
phasestring
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/persistentvolumeclaims"

+
+

kind#

+

▪ Static kind: string = "PersistentVolumeClaim"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getMatchExpressions#

+

▸ getMatchExpressions(): { key: string ; operator: string ; values: string[] }[]

+

Returns#

+

{ key: string ; operator: string ; values: string[] }[]

+
+

getMatchLabels#

+

▸ getMatchLabels(): string[]

+

Returns#

+

string[]

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getPods#

+

▸ getPods(allPods): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
allPodsPod[]
+

Returns#

+

Pod[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getStatus#

+

▸ getStatus(): string

+

Returns#

+

string

+
+

getStorage#

+

▸ getStorage(): string

+

Returns#

+

string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<PersistentVolumeClaim>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html new file mode 100644 index 0000000000..553dbbeacf --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/index.html @@ -0,0 +1,1630 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaimsApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PersistentVolumeClaimsApi#

+

Renderer.K8sApi.PersistentVolumeClaimsApi

+

Hierarchy#

+ +

↳ PersistentVolumeClaimsApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PersistentVolumeClaimsApi(options)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<PersistentVolumeClaim>
+

Inherited from#

+

KubeApi.constructor

+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+

Inherited from#

+

KubeApi.apiBase

+
+

apiGroup#

+

• Readonly apiGroup: string

+

Inherited from#

+

KubeApi.apiGroup

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+

Inherited from#

+

KubeApi.apiPrefix

+
+

apiResource#

+

• Readonly apiResource: string

+

Inherited from#

+

KubeApi.apiResource

+
+

apiVersion#

+

• Readonly apiVersion: string

+

Inherited from#

+

KubeApi.apiVersion

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+

Inherited from#

+

KubeApi.apiVersionPreferred

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+

Inherited from#

+

KubeApi.isNamespaced

+
+

kind#

+

• Readonly kind: string

+

Inherited from#

+

KubeApi.kind

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<PersistentVolumeClaim>

+

Inherited from#

+

KubeApi.objectConstructor

+
+

options#

+

• Protected options: IKubeApiOptions<PersistentVolumeClaim>

+

Inherited from#

+

KubeApi.options

+
+

request#

+

• Protected request: KubeJsonApi

+

Inherited from#

+

KubeApi.request

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+

Inherited from#

+

KubeApi.resourceVersions

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watchDisposer

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeApi.checkPreferredVersion

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeApi.create

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeApi.delete

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeApi.get

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getResourceVersion

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getUrl

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getWatchUrl

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<PersistentVolumeClaim[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<PersistentVolumeClaim[]>

+

Inherited from#

+

KubeApi.list

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+

Inherited from#

+

KubeApi.modifyWatchEvent

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+

Inherited from#

+

KubeApi.normalizeQuery

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): PersistentVolumeClaim | PersistentVolumeClaim[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

PersistentVolumeClaim | PersistentVolumeClaim[]

+

Inherited from#

+

KubeApi.parseResponse

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<PersistentVolumeClaim[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<PersistentVolumeClaim[]>

+

Inherited from#

+

KubeApi.refreshResourceVersion

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+

Inherited from#

+

KubeApi.setResourceVersion

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeApi.update

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watch

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html new file mode 100644 index 0000000000..7e9d1b3339 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html @@ -0,0 +1,2367 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumesStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PersistentVolumesStore#

+

Renderer.K8sApi.PersistentVolumesStore

+

Hierarchy#

+ +

↳ PersistentVolumesStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PersistentVolumesStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<PersistentVolume>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<PersistentVolume, void, undefined>

+

Returns#

+

Generator<PersistentVolume, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PersistentVolume>
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PersistentVolume>
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPersistentVolume[]
+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): PersistentVolume

+

Parameters#

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

Returns#

+

PersistentVolume

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): PersistentVolume

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

PersistentVolume

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): PersistentVolume

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

PersistentVolume

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getByStorageClass#

+

▸ getByStorageClass(storageClass): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
storageClassStorageClass
+

Returns#

+

PersistentVolume[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): PersistentVolume[]

+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPersistentVolume[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPersistentVolume[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | PersistentVolume[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | PersistentVolume[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<PersistentVolume[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<PersistentVolume>
+

Returns#

+

Promise<PersistentVolume[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsPersistentVolume[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolume
patchPatch
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | PersistentVolume[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | PersistentVolume[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolume
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): PersistentVolume[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsPersistentVolume[]the items to be sorted (default: the current items in this store)
sorting(item: PersistentVolume) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

PersistentVolume[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPersistentVolume[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolume
dataPartial<PersistentVolume>
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<PersistentVolume>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolume
request() => Promise<PersistentVolume>
+

Returns#

+

Promise<PersistentVolume>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.pod/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.pod/index.html new file mode 100644 index 0000000000..269a88cc17 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.pod/index.html @@ -0,0 +1,2307 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Pod - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Pod#

+

Renderer.K8sApi.Pod

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ Pod

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Pod(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• Optional spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
activeDeadlineSeconds?number
affinity?IAffinity
automountServiceAccountToken?boolean
containersIPodContainer[]
dnsPolicy?string
hostAliases?Object
hostAliases.hostnamesstring[]
hostAliases.ipstring
hostIPC?boolean
hostNetwork?boolean
hostPID?boolean
hostname?string
imagePullSecrets?{ name: string }[]
initContainersIPodContainer[]
nodeName?string
nodeSelector?Object
priority?number
priorityClassName?string
restartPolicy?string
schedulerName?string
securityContext?Object
serviceAccountstring
serviceAccountNamestring
shareProcessNamespace?boolean
subdomain?string
terminationGracePeriodSeconds?number
tolerations?{ effect?: string ; key?: string ; operator?: string ; tolerationSeconds?: number ; value?: string }[]
volumes?{ configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• Optional status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
conditions{ lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]
containerStatuses?IPodContainerStatus[]
hostIPstring
initContainerStatuses?IPodContainerStatus[]
phasestring
podIPstring
podIPs?{ ip: string }[]
qosClass?string
reason?string
startTimestring
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/pods"

+
+

kind#

+

▪ Static kind: string = "Pod"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Overrides#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAllContainers#

+

▸ getAllContainers(): IPodContainer[]

+

Returns#

+

IPodContainer[]

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getConditions#

+

▸ getConditions(): { lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]

+

Returns#

+

{ lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]

+
+

getContainerStatuses#

+

▸ getContainerStatuses(includeInitContainers?): IPodContainerStatus[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
includeInitContainersbooleantrue
+

Returns#

+

IPodContainerStatus[]

+
+

getContainers#

+

▸ getContainers(): IPodContainer[]

+

Returns#

+

IPodContainer[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getIPs#

+

▸ getIPs(): string[]

+

Returns#

+

string[]

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getInitContainers#

+

▸ getInitContainers(): IPodContainer[]

+

Returns#

+

IPodContainer[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getLivenessProbe#

+

▸ getLivenessProbe(container): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns#

+

string[]

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeName#

+

▸ getNodeName(): string

+

Returns#

+

string

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Overrides#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getPriorityClassName#

+

▸ getPriorityClassName(): string

+

Returns#

+

string

+
+

getProbe#

+

▸ getProbe(probeData): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
probeDataIContainerProbe
+

Returns#

+

string[]

+
+

getQosClass#

+

▸ getQosClass(): string

+

Returns#

+

string

+
+

getReadinessProbe#

+

▸ getReadinessProbe(container): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns#

+

string[]

+
+

getReason#

+

▸ getReason(): string

+

Returns#

+

string

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getRestartsCount#

+

▸ getRestartsCount(): number

+

Returns#

+

number

+
+

getRunningContainers#

+

▸ getRunningContainers(): IPodContainer[]

+

Returns#

+

IPodContainer[]

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSecrets#

+

▸ getSecrets(): string[]

+

Returns#

+

string[]

+
+

getSelectedNodeOs#

+

▸ getSelectedNodeOs(): string

+

Returns#

+

string

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getStartupProbe#

+

▸ getStartupProbe(container): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns#

+

string[]

+
+

getStatus#

+

▸ getStatus(): PodStatus

+

Returns#

+

PodStatus

+
+

getStatusMessage#

+

▸ getStatusMessage(): string

+

Returns#

+

string

+
+

getStatusPhase#

+

▸ getStatusPhase(): string

+

Returns#

+

string

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): { effect?: string ; key?: string ; operator?: string ; tolerationSeconds?: number ; value?: string }[]

+

Returns#

+

{ effect?: string ; key?: string ; operator?: string ; tolerationSeconds?: number ; value?: string }[]

+

Overrides#

+

WorkloadKubeObject.getTolerations

+
+

getVolumes#

+

▸ getVolumes(): { configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]

+

Returns#

+

{ configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]

+
+

hasIssues#

+

▸ hasIssues(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Pod>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html new file mode 100644 index 0000000000..e31177cd70 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/index.html @@ -0,0 +1,1786 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudget - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodDisruptionBudget#

+

Renderer.K8sApi.PodDisruptionBudget

+

Hierarchy#

+ +

↳ PodDisruptionBudget

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PodDisruptionBudget(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
maxUnavailablestring
minAvailablestring
selectorObject
selector.matchLabelsObject
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
currentHealthynumber
desiredHealthynumber
disruptionsAllowednumber
expectedPodsnumber
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/policy/v1beta1/poddisruptionbudgets"

+
+

kind#

+

▪ Static kind: string = "PodDisruptionBudget"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getCurrentHealthy#

+

▸ getCurrentHealthy(): number

+

Returns#

+

number

+
+

getDesiredHealthy#

+

▸ getDesiredHealthy(): number

+

Returns#

+

number

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getMaxUnavailable#

+

▸ getMaxUnavailable(): string

+

Returns#

+

string

+
+

getMinAvailable#

+

▸ getMinAvailable(): string

+

Returns#

+

string

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<PodDisruptionBudget>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html new file mode 100644 index 0000000000..481e449570 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudgetsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodDisruptionBudgetsStore#

+

Renderer.K8sApi.PodDisruptionBudgetsStore

+

Hierarchy#

+ +

↳ PodDisruptionBudgetsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PodDisruptionBudgetsStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<PodDisruptionBudget>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<PodDisruptionBudget>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<PodDisruptionBudget, void, undefined>

+

Returns#

+

Generator<PodDisruptionBudget, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PodDisruptionBudget>
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PodDisruptionBudget>
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): PodDisruptionBudget[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPodDisruptionBudget[]
+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): PodDisruptionBudget[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): PodDisruptionBudget

+

Parameters#

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

Returns#

+

PodDisruptionBudget

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): PodDisruptionBudget[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): PodDisruptionBudget

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

PodDisruptionBudget

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): PodDisruptionBudget

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

PodDisruptionBudget

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): PodDisruptionBudget[]

+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPodDisruptionBudget[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPodDisruptionBudget[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | PodDisruptionBudget[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | PodDisruptionBudget[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<PodDisruptionBudget[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<PodDisruptionBudget>
+

Returns#

+

Promise<PodDisruptionBudget[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): PodDisruptionBudget[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsPodDisruptionBudget[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
patchPatch
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | PodDisruptionBudget[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | PodDisruptionBudget[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): PodDisruptionBudget[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsPodDisruptionBudget[]the items to be sorted (default: the current items in this store)
sorting(item: PodDisruptionBudget) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

PodDisruptionBudget[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPodDisruptionBudget[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
dataPartial<PodDisruptionBudget>
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<PodDisruptionBudget>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
request() => Promise<PodDisruptionBudget>
+

Returns#

+

Promise<PodDisruptionBudget>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.podsapi/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.podsapi/index.html new file mode 100644 index 0000000000..0ad7bfac95 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.podsapi/index.html @@ -0,0 +1,1670 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodsApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodsApi#

+

Renderer.K8sApi.PodsApi

+

Hierarchy#

+ +

↳ PodsApi

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PodsApi(options)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions<Pod>
+

Inherited from#

+

KubeApi.constructor

+

Properties#

+

apiBase#

+

• Readonly apiBase: string

+

Inherited from#

+

KubeApi.apiBase

+
+

apiGroup#

+

• Readonly apiGroup: string

+

Inherited from#

+

KubeApi.apiGroup

+
+

apiPrefix#

+

• Readonly apiPrefix: string

+

Inherited from#

+

KubeApi.apiPrefix

+
+

apiResource#

+

• Readonly apiResource: string

+

Inherited from#

+

KubeApi.apiResource

+
+

apiVersion#

+

• Readonly apiVersion: string

+

Inherited from#

+

KubeApi.apiVersion

+
+

apiVersionPreferred#

+

• Optional Readonly apiVersionPreferred: string

+

Inherited from#

+

KubeApi.apiVersionPreferred

+
+

isNamespaced#

+

• Readonly isNamespaced: boolean

+

Inherited from#

+

KubeApi.isNamespaced

+
+

kind#

+

• Readonly kind: string

+

Inherited from#

+

KubeApi.kind

+
+

objectConstructor#

+

• objectConstructor: KubeObjectConstructor<Pod>

+

Inherited from#

+

KubeApi.objectConstructor

+
+

options#

+

• Protected options: IKubeApiOptions<Pod>

+

Inherited from#

+

KubeApi.options

+
+

request#

+

• Protected request: KubeJsonApi

+

Inherited from#

+

KubeApi.request

+
+

resourceVersions#

+

• Protected resourceVersions: Map<string, string>

+

Inherited from#

+

KubeApi.resourceVersions

+
+

watchDisposer#

+

• Protected watchDisposer: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watchDisposer

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Returns#

+

string

+

Methods#

+

checkPreferredVersion#

+

▸ Protected checkPreferredVersion(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeApi.checkPreferredVersion

+
+

create#

+

▸ create(__namedParameters?, data?): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeApi.create

+
+

delete#

+

▸ delete(__namedParameters): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersObject
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeApi.delete

+
+

get#

+

▸ get(__namedParameters?, query?): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?IKubeApiQueryParams
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeApi.get

+
+

getLogs#

+

▸ getLogs(params, query?): Promise<string>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
query?IPodLogsQuery
+

Returns#

+

Promise<string>

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace?): string

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getResourceVersion

+
+

getUrl#

+

▸ getUrl(__namedParameters?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
query?Partial<IKubeApiQueryParams>
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getUrl

+
+

getWatchUrl#

+

▸ getWatchUrl(namespace?, query?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
queryIKubeApiQueryParams{}
+

Returns#

+

string

+

Inherited from#

+

KubeApi.getWatchUrl

+
+

list#

+

▸ list(__namedParameters?, query?): Promise<Pod[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
__namedParametersKubeApiListOptions
query?IKubeApiQueryParams
+

Returns#

+

Promise<Pod[]>

+

Inherited from#

+

KubeApi.list

+
+

modifyWatchEvent#

+

▸ Protected modifyWatchEvent(event): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent<KubeJsonApiData>
+

Returns#

+

void

+

Inherited from#

+

KubeApi.modifyWatchEvent

+
+

normalizeQuery#

+

▸ Protected normalizeQuery(query?): Partial<IKubeApiQueryParams>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
queryPartial<IKubeApiQueryParams>
+

Returns#

+

Partial<IKubeApiQueryParams>

+

Inherited from#

+

KubeApi.normalizeQuery

+
+

parseResponse#

+

▸ Protected parseResponse(data, namespace?): Pod | Pod[]

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns#

+

Pod | Pod[]

+

Inherited from#

+

KubeApi.parseResponse

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?): Promise<Pod[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns#

+

Promise<Pod[]>

+

Inherited from#

+

KubeApi.refreshResourceVersion

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace?, newVersion): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring""
newVersionstringundefined
+

Returns#

+

void

+

Inherited from#

+

KubeApi.setResourceVersion

+
+

update#

+

▸ update(__namedParameters?, data?): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.name
__namedParameters.namespace
data?Partial<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeApi.update

+
+

watch#

+

▸ watch(opts?): () => void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
optsKubeApiWatchOptions
+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeApi.watch

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.podsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.podsstore/index.html new file mode 100644 index 0000000000..d01a1eabe5 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.podsstore/index.html @@ -0,0 +1,2508 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodsStore#

+

Renderer.K8sApi.PodsStore

+

Hierarchy#

+ +

↳ PodsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PodsStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: PodsApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Pod>

+

Inherited from#

+

KubeObjectStore.items

+
+

kubeMetrics#

+

• kubeMetrics: IObservableArray<PodMetrics>

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Pod, void, undefined>

+

Returns#

+

Generator<Pod, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPod[]
+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Pod[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Pod

+

Parameters#

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

Returns#

+

Pod

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Pod

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Pod

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Pod

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Pod

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Pod[]

+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getPodKubeMetrics#

+

▸ getPodKubeMetrics(pod): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
podPod
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + +
NameType
cpunumber
memorynumber
+
+

getPodsByNode#

+

▸ getPodsByNode(node): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
nodestring
+

Returns#

+

Pod[]

+
+

getPodsByOwner#

+

▸ getPodsByOwner(workload): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
workloadWorkloadKubeObject
+

Returns#

+

Pod[]

+
+

getPodsByOwnerId#

+

▸ getPodsByOwnerId(workloadId): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
workloadIdstring
+

Returns#

+

Pod[]

+
+

getStatuses#

+

▸ getStatuses(pods): Dictionary<number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
podsPod[]
+

Returns#

+

Dictionary<number>

+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPod[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Pod[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Pod[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Pod[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Pod>
+

Returns#

+

Promise<Pod[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

loadKubeMetrics#

+

▸ loadKubeMetrics(namespace?): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
namespace?string
+

Returns#

+

Promise<void>

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Pod[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsPod[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPod
patchPatch
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Pod[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Pod[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPod
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Pod[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsPod[]the items to be sorted (default: the current items in this store)
sorting(item: Pod) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Pod[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPod[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPod
dataPartial<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Pod>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPod
request() => Promise<Pod>
+

Returns#

+

Promise<Pod>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.replicaset/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.replicaset/index.html new file mode 100644 index 0000000000..779bd518e9 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.replicaset/index.html @@ -0,0 +1,2003 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSet - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ReplicaSet#

+

Renderer.K8sApi.ReplicaSet

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ ReplicaSet

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ReplicaSet(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
minReadySeconds?number
replicas?number
selectorObject
selector.matchLabelsObject
template?Object
template.metadataObject
template.metadata.labelsObject
template.metadata.labels.appstring
template.spec?Object
template.spec.activeDeadlineSeconds?number
template.spec.affinity?IAffinity
template.spec.automountServiceAccountToken?boolean
template.spec.containersIPodContainer[]
template.spec.dnsPolicy?string
template.spec.hostAliases?Object
template.spec.hostAliases.hostnamesstring[]
template.spec.hostAliases.ipstring
template.spec.hostIPC?boolean
template.spec.hostNetwork?boolean
template.spec.hostPID?boolean
template.spec.hostname?string
template.spec.imagePullSecrets?{ name: string }[]
template.spec.initContainersIPodContainer[]
template.spec.nodeName?string
template.spec.nodeSelector?Object
template.spec.priority?number
template.spec.priorityClassName?string
template.spec.restartPolicy?string
template.spec.schedulerName?string
template.spec.securityContext?Object
template.spec.serviceAccountstring
template.spec.serviceAccountNamestring
template.spec.shareProcessNamespace?boolean
template.spec.subdomain?string
template.spec.terminationGracePeriodSeconds?number
template.spec.tolerations?{ effect?: string ; key?: string ; operator?: string ; tolerationSeconds?: number ; value?: string }[]
template.spec.volumes?{ configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
availableReplicas?number
conditions?{ lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]
fullyLabeledReplicas?number
observedGeneration?number
readyReplicas?number
replicasnumber
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/apps/v1/replicasets"

+
+

kind#

+

▪ Static kind: string = "ReplicaSet"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Inherited from#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getCurrent#

+

▸ getCurrent(): number

+

Returns#

+

number

+
+

getDesired#

+

▸ getDesired(): number

+

Returns#

+

number

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getImages#

+

▸ getImages(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getReady#

+

▸ getReady(): number

+

Returns#

+

number

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): IToleration[]

+

Returns#

+

IToleration[]

+

Inherited from#

+

WorkloadKubeObject.getTolerations

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ReplicaSet>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html new file mode 100644 index 0000000000..d192b2241c --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html @@ -0,0 +1,2417 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSetStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ReplicaSetStore#

+

Renderer.K8sApi.ReplicaSetStore

+

Hierarchy#

+ +

↳ ReplicaSetStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ReplicaSetStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: ReplicaSetApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<ReplicaSet, void, undefined>

+

Returns#

+

Generator<ReplicaSet, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ReplicaSet>
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ReplicaSet>
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): ReplicaSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsReplicaSet[]
+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): ReplicaSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): ReplicaSet

+

Parameters#

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

Returns#

+

ReplicaSet

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): ReplicaSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): ReplicaSet

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

ReplicaSet

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): ReplicaSet

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

ReplicaSet

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getChildPods#

+

▸ getChildPods(replicaSet): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
replicaSetReplicaSet
+

Returns#

+

Pod[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): ReplicaSet[]

+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getReplicaSetsByOwner#

+

▸ getReplicaSetsByOwner(deployment): ReplicaSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
deploymentDeployment
+

Returns#

+

ReplicaSet[]

+
+

getStatuses#

+

▸ getStatuses(replicaSets): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
replicaSetsReplicaSet[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + +
NameType
failednumber
pendingnumber
runningnumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsReplicaSet[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | ReplicaSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | ReplicaSet[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<ReplicaSet[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<ReplicaSet>
+

Returns#

+

Promise<ReplicaSet[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): ReplicaSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsReplicaSet[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemReplicaSet
patchPatch
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | ReplicaSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | ReplicaSet[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemReplicaSet
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): ReplicaSet[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsReplicaSet[]the items to be sorted (default: the current items in this store)
sorting(item: ReplicaSet) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

ReplicaSet[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsReplicaSet[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemReplicaSet
dataPartial<ReplicaSet>
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<ReplicaSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemReplicaSet
request() => Promise<ReplicaSet>
+

Returns#

+

Promise<ReplicaSet>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequota/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequota/index.html new file mode 100644 index 0000000000..79add48209 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequota/index.html @@ -0,0 +1,1722 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuota - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ResourceQuota#

+

Renderer.K8sApi.ResourceQuota

+

Hierarchy#

+ +

↳ ResourceQuota

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ResourceQuota(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
hardIResourceQuotaValues
scopeSelector?Object
scopeSelector.matchExpressions{ operator: string ; scopeName: string ; values: string[] }[]
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
hardIResourceQuotaValues
usedIResourceQuotaValues
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/resourcequotas"

+
+

kind#

+

▪ Static kind: string = "ResourceQuota"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getScopeSelector#

+

▸ getScopeSelector(): { operator: string ; scopeName: string ; values: string[] }[]

+

Returns#

+

{ operator: string ; scopeName: string ; values: string[] }[]

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ResourceQuota>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html new file mode 100644 index 0000000000..a3cd3f4e0b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuotasStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ResourceQuotasStore#

+

Renderer.K8sApi.ResourceQuotasStore

+

Hierarchy#

+ +

↳ ResourceQuotasStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ResourceQuotasStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<ResourceQuota>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<ResourceQuota>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<ResourceQuota, void, undefined>

+

Returns#

+

Generator<ResourceQuota, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ResourceQuota>
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ResourceQuota>
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): ResourceQuota[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsResourceQuota[]
+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): ResourceQuota[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): ResourceQuota

+

Parameters#

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

Returns#

+

ResourceQuota

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): ResourceQuota[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): ResourceQuota

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

ResourceQuota

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): ResourceQuota

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

ResourceQuota

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): ResourceQuota[]

+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsResourceQuota[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsResourceQuota[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | ResourceQuota[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | ResourceQuota[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<ResourceQuota[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<ResourceQuota>
+

Returns#

+

Promise<ResourceQuota[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): ResourceQuota[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsResourceQuota[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemResourceQuota
patchPatch
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | ResourceQuota[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | ResourceQuota[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemResourceQuota
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): ResourceQuota[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsResourceQuota[]the items to be sorted (default: the current items in this store)
sorting(item: ResourceQuota) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

ResourceQuota[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsResourceQuota[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemResourceQuota
dataPartial<ResourceQuota>
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<ResourceQuota>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemResourceQuota
request() => Promise<ResourceQuota>
+

Returns#

+

Promise<ResourceQuota>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcestack/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcestack/index.html new file mode 100644 index 0000000000..38f85bc09e --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcestack/index.html @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ResourceStack - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ResourceStack#

+

Renderer.K8sApi.ResourceStack

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ResourceStack(cluster, name)

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
clusterKubernetesCluster
namestring
+

Properties#

+

cluster#

+

• Protected cluster: KubernetesCluster

+
+

name#

+

• Protected name: string

+

Methods#

+

appendKubectlArgs#

+

▸ Protected appendKubectlArgs(kubectlArgs): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
kubectlArgsstring[]
+

Returns#

+

string[]

+
+

applyResources#

+

▸ Protected applyResources(resources, extraArgs?): Promise<string>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
resourcesstring[]
extraArgs?string[]
+

Returns#

+

Promise<string>

+
+

deleteResources#

+

▸ Protected deleteResources(resources, extraArgs?): Promise<string>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
resourcesstring[]
extraArgs?string[]
+

Returns#

+

Promise<string>

+
+

kubectlApplyFolder#

+

▸ kubectlApplyFolder(folderPath, templateContext?, extraArgs?): Promise<string>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
folderPathstringfolder path that is searched for files defining kubernetes resources.
templateContext?anysets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.
extraArgs?string[]-
+

Returns#

+

Promise<string>

+
+

kubectlDeleteFolder#

+

▸ kubectlDeleteFolder(folderPath, templateContext?, extraArgs?): Promise<string>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
folderPathstringfolder path that is searched for files defining kubernetes resources.
templateContext?anysets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.
extraArgs?string[]-
+

Returns#

+

Promise<string>

+
+

renderTemplates#

+

▸ Protected renderTemplates(folderPath, templateContext): Promise<string[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
folderPathstring
templateContextany
+

Returns#

+

Promise<string[]>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.role/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.role/index.html new file mode 100644 index 0000000000..1a9cbfd625 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.role/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Role - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Role#

+

Renderer.K8sApi.Role

+

Hierarchy#

+ +

↳ Role

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Role(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

rules#

+

• rules: { apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

+
+

kind#

+

▪ Static kind: string = "Role"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getRules#

+

▸ getRules(): { apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+

Returns#

+

{ apiGroups: string[] ; resourceNames?: string[] ; resources: string[] ; verbs: string[] }[]

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Role>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebinding/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebinding/index.html new file mode 100644 index 0000000000..1597bb8d98 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebinding/index.html @@ -0,0 +1,1738 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RoleBinding - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RoleBinding#

+

Renderer.K8sApi.RoleBinding

+

Hierarchy#

+ +

↳ RoleBinding

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new RoleBinding(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

roleRef#

+

• roleRef: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
apiGroup?string
kindstring
namestring
+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

subjects#

+

• Optional subjects: RoleBindingSubject[]

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/rbac.authorization.k8s.io/v1/rolebindings"

+
+

kind#

+

▪ Static kind: string = "RoleBinding"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSubjectNames#

+

▸ getSubjectNames(): string

+

Returns#

+

string

+
+

getSubjects#

+

▸ getSubjects(): RoleBindingSubject[]

+

Returns#

+

RoleBindingSubject[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<RoleBinding>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html new file mode 100644 index 0000000000..c44811d704 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html @@ -0,0 +1,2406 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RoleBindingsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RoleBindingsStore#

+

Renderer.K8sApi.RoleBindingsStore

+

Hierarchy#

+ +

↳ RoleBindingsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new RoleBindingsStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<RoleBinding>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<RoleBinding>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<RoleBinding>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<RoleBinding, void, undefined>

+

Returns#

+

Generator<RoleBinding, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<RoleBinding>
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespacestring
data?Partial<RoleBinding>
+

Returns#

+

Promise<RoleBinding>

+

Overrides#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): RoleBinding[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRoleBinding[]
+

Returns#

+

RoleBinding[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): RoleBinding[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

RoleBinding[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): RoleBinding

+

Parameters#

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

Returns#

+

RoleBinding

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): RoleBinding[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

RoleBinding[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): RoleBinding

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

RoleBinding

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): RoleBinding

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

RoleBinding

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): RoleBinding[]

+

Returns#

+

RoleBinding[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRoleBinding[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsRoleBinding[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | RoleBinding[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | RoleBinding[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<RoleBinding[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<RoleBinding>
+

Returns#

+

Promise<RoleBinding[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): RoleBinding[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsRoleBinding[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

RoleBinding[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRoleBinding
patchPatch
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | RoleBinding[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | RoleBinding[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRoleBinding
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

removeSubjects#

+

▸ removeSubjects(roleBinding, subjectsToRemove): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
roleBindingRoleBinding
subjectsToRemoveIterable<RoleBindingSubject>
+

Returns#

+

Promise<RoleBinding>

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items): RoleBinding[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRoleBinding[]
+

Returns#

+

RoleBinding[]

+

Overrides#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsRoleBinding[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRoleBinding
dataPartial<RoleBinding>
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRoleBinding
request() => Promise<RoleBinding>
+

Returns#

+

Promise<RoleBinding>

+

Inherited from#

+

KubeObjectStore.updateItem

+
+

updateSubjects#

+

▸ updateSubjects(roleBinding, subjects): Promise<RoleBinding>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
roleBindingRoleBinding
subjectsRoleBindingSubject[]
+

Returns#

+

Promise<RoleBinding>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.rolesstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolesstore/index.html new file mode 100644 index 0000000000..ba003df157 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.rolesstore/index.html @@ -0,0 +1,2327 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RolesStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RolesStore#

+

Renderer.K8sApi.RolesStore

+

Hierarchy#

+ +

↳ RolesStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new RolesStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<Role>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Role>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Role, void, undefined>

+

Returns#

+

Generator<Role, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Role>
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Role>
+

Returns#

+

Promise<Role>

+

Overrides#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Role[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRole[]
+

Returns#

+

Role[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Role[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Role[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Role

+

Parameters#

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

Returns#

+

Role

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Role[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Role[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Role

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Role

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Role

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Role

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Role[]

+

Returns#

+

Role[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRole[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsRole[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Role[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Role[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Role[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Role>
+

Returns#

+

Promise<Role[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Role[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsRole[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Role[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRole
patchPatch
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Role[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Role[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRole
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items): Role[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsRole[]
+

Returns#

+

Role[]

+

Overrides#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsRole[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRole
dataPartial<Role>
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Role>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemRole
request() => Promise<Role>
+

Returns#

+

Promise<Role>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.secret/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.secret/index.html new file mode 100644 index 0000000000..32aa787524 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.secret/index.html @@ -0,0 +1,1732 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Secret - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Secret#

+

Renderer.K8sApi.Secret

+

Hierarchy#

+ +

↳ Secret

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Secret(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

data#

+

• data: Object

+

Index signature#

+

▪ [prop: string]: string

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
token?string
+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

type#

+

• type: SecretType

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/secrets"

+
+

kind#

+

▪ Static kind: string = "Secret"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getKeys#

+

▸ getKeys(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getToken#

+

▸ getToken(): string

+

Returns#

+

string

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Secret>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.secretsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.secretsstore/index.html new file mode 100644 index 0000000000..3e89ec0b33 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.secretsstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: SecretsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: SecretsStore#

+

Renderer.K8sApi.SecretsStore

+

Hierarchy#

+ +

↳ SecretsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new SecretsStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<Secret>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<Secret>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Secret>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Secret, void, undefined>

+

Returns#

+

Generator<Secret, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Secret>
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Secret>
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Secret[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsSecret[]
+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Secret[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Secret

+

Parameters#

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

Returns#

+

Secret

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Secret[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Secret

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Secret

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Secret

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Secret

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Secret[]

+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsSecret[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsSecret[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Secret[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Secret[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Secret[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Secret>
+

Returns#

+

Promise<Secret[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Secret[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsSecret[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemSecret
patchPatch
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Secret[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Secret[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemSecret
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Secret[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsSecret[]the items to be sorted (default: the current items in this store)
sorting(item: Secret) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Secret[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsSecret[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemSecret
dataPartial<Secret>
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Secret>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemSecret
request() => Promise<Secret>
+

Returns#

+

Promise<Secret>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.service/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.service/index.html new file mode 100644 index 0000000000..7a7b768ed7 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.service/index.html @@ -0,0 +1,1926 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Service - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Service#

+

Renderer.K8sApi.Service

+

Hierarchy#

+ +

↳ Service

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new Service(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
allocateLoadBalancerNodePorts?boolean
clusterIPstring
clusterIPs?string[]
externalIPs?string[]
externalNamestring
externalTrafficPolicy?string
healthCheckNodePort?number
internalTrafficPolicy?string
ipFamilies?string[]
ipFamilyPolicy?string
loadBalancerClass?string
loadBalancerIP?string
loadBalancerSourceRanges?string[]
portsServicePort[]
selectorObject
sessionAffinitystring
topologyKeys?string[]
typestring
+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
loadBalancer?Object
loadBalancer.ingress?{ hostname?: string ; ip?: string }[]
+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/services"

+
+

kind#

+

▪ Static kind: string = "Service"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getClusterIp#

+

▸ getClusterIp(): string

+

Returns#

+

string

+
+

getClusterIps#

+

▸ getClusterIps(): string[]

+

Returns#

+

string[]

+
+

getExternalIps#

+

▸ getExternalIps(): string[]

+

Returns#

+

string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getIpFamilies#

+

▸ getIpFamilies(): string[]

+

Returns#

+

string[]

+
+

getIpFamilyPolicy#

+

▸ getIpFamilyPolicy(): string

+

Returns#

+

string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getLoadBalancer#

+

▸ getLoadBalancer(): Object

+

Returns#

+

Object

+ + + + + + + + + + + + + +
NameType
ingress?{ hostname?: string ; ip?: string }[]
+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getPorts#

+

▸ getPorts(): ServicePort[]

+

Returns#

+

ServicePort[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSelector#

+

▸ getSelector(): string[]

+

Returns#

+

string[]

+
+

getStatus#

+

▸ getStatus(): "Active" | "Pending"

+

Returns#

+

"Active" | "Pending"

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getType#

+

▸ getType(): string

+

Returns#

+

string

+
+

isActive#

+

▸ isActive(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<Service>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html new file mode 100644 index 0000000000..81110c34e6 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html @@ -0,0 +1,1715 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccount - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ServiceAccount#

+

Renderer.K8sApi.ServiceAccount

+

Hierarchy#

+ +

↳ ServiceAccount

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ServiceAccount(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

imagePullSecrets#

+

• Optional imagePullSecrets: { name: string }[]

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

secrets#

+

• Optional secrets: { name: string }[]

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/api/v1/serviceaccounts"

+
+

kind#

+

▪ Static kind: string = "ServiceAccount"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getImagePullSecrets#

+

▸ getImagePullSecrets(): { name: string }[]

+

Returns#

+

{ name: string }[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getSecrets#

+

▸ getSecrets(): { name: string }[]

+

Returns#

+

{ name: string }[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<ServiceAccount>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html new file mode 100644 index 0000000000..b3182cb730 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html @@ -0,0 +1,2335 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccountsStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ServiceAccountsStore#

+

Renderer.K8sApi.ServiceAccountsStore

+

Hierarchy#

+ +

↳ ServiceAccountsStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ServiceAccountsStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<ServiceAccount>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<ServiceAccount, void, undefined>

+

Returns#

+

Generator<ServiceAccount, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<ServiceAccount>
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ServiceAccount>

+

Overrides#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): ServiceAccount[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsServiceAccount[]
+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): ServiceAccount[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): ServiceAccount

+

Parameters#

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

Returns#

+

ServiceAccount

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): ServiceAccount[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): ServiceAccount

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

ServiceAccount

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): ServiceAccount

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

ServiceAccount

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): ServiceAccount[]

+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsServiceAccount[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsServiceAccount[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | ServiceAccount[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | ServiceAccount[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<ServiceAccount[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<ServiceAccount>
+

Returns#

+

Promise<ServiceAccount[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): ServiceAccount[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsServiceAccount[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemServiceAccount
patchPatch
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | ServiceAccount[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | ServiceAccount[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemServiceAccount
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): ServiceAccount[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsServiceAccount[]the items to be sorted (default: the current items in this store)
sorting(item: ServiceAccount) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

ServiceAccount[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsServiceAccount[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemServiceAccount
dataPartial<ServiceAccount>
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<ServiceAccount>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemServiceAccount
request() => Promise<ServiceAccount>
+

Returns#

+

Promise<ServiceAccount>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.servicestore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.servicestore/index.html new file mode 100644 index 0000000000..0b72d1f611 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.servicestore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ServiceStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ServiceStore#

+

Renderer.K8sApi.ServiceStore

+

Hierarchy#

+ +

↳ ServiceStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new ServiceStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<Service>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<Service>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<Service>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<Service, void, undefined>

+

Returns#

+

Generator<Service, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Service>
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<Service>
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): Service[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsService[]
+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): Service[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): Service

+

Parameters#

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

Returns#

+

Service

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): Service[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): Service

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

Service

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): Service

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

Service

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): Service[]

+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsService[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsService[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | Service[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | Service[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<Service[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<Service>
+

Returns#

+

Promise<Service[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): Service[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsService[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemService
patchPatch
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | Service[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | Service[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemService
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): Service[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsService[]the items to be sorted (default: the current items in this store)
sorting(item: Service) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

Service[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsService[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemService
dataPartial<Service>
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<Service>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemService
request() => Promise<Service>
+

Returns#

+

Promise<Service>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulset/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulset/index.html new file mode 100644 index 0000000000..616408a2b3 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulset/index.html @@ -0,0 +1,1889 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSet - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StatefulSet#

+

Renderer.K8sApi.StatefulSet

+

Hierarchy#

+
    +
  • WorkloadKubeObject
    • +
+

↳ StatefulSet

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new StatefulSet(data)

+

Parameters#

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

Overrides#

+

WorkloadKubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

WorkloadKubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

WorkloadKubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

WorkloadKubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

WorkloadKubeObject.metadata

+
+

spec#

+

• spec: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
replicasnumber
selectorObject
selector.matchLabelsObject
serviceNamestring
templateObject
template.metadataObject
template.metadata.labelsObject
template.metadata.labels.appstring
template.specObject
template.spec.affinity?IAffinity
template.spec.containers{ image: string ; name: string ; ports: { containerPort: number ; name: string }[] ; volumeMounts: { mountPath: string ; name: string }[] }[]
template.spec.nodeSelector?Object
template.spec.tolerations{ effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]
volumeClaimTemplates{ metadata: { name: string } ; spec: { accessModes: string[] ; resources: { requests: { storage: string } } } }[]
+

Overrides#

+

WorkloadKubeObject.spec

+
+

status#

+

• status: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
collisionCountnumber
currentReplicasnumber
currentRevisionstring
observedGenerationnumber
readyReplicasnumber
replicasnumber
updateRevisionstring
+

Overrides#

+

WorkloadKubeObject.status

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/apps/v1/statefulsets"

+
+

kind#

+

▪ Static kind: string = "StatefulSet"

+

Overrides#

+

WorkloadKubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = true

+

Overrides#

+

WorkloadKubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.delete

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Returns#

+

IAffinity

+

Inherited from#

+

WorkloadKubeObject.getAffinity

+
+

getAffinityNumber#

+

▸ getAffinityNumber(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getAffinityNumber

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

WorkloadKubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getId

+
+

getImages#

+

▸ getImages(): string[]

+

Returns#

+

string[]

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getName

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getNodeSelectors

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

WorkloadKubeObject.getOwnerRefs

+
+

getReplicas#

+

▸ getReplicas(): number

+

Returns#

+

number

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

WorkloadKubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSearchFields

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getSelectors

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.getTemplateLabels

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

WorkloadKubeObject.getTimeDiffFromNow

+
+

getTolerations#

+

▸ getTolerations(): IToleration[]

+

Returns#

+

IToleration[]

+

Inherited from#

+

WorkloadKubeObject.getTolerations

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

WorkloadKubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<StatefulSet>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

WorkloadKubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

WorkloadKubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

WorkloadKubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

WorkloadKubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

WorkloadKubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

WorkloadKubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

WorkloadKubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html new file mode 100644 index 0000000000..2056e47c70 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html @@ -0,0 +1,2389 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSetStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StatefulSetStore#

+

Renderer.K8sApi.StatefulSetStore

+

Hierarchy#

+ +

↳ StatefulSetStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new StatefulSetStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: StatefulSetApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<StatefulSet>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<StatefulSet, void, undefined>

+

Returns#

+

Generator<StatefulSet, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<StatefulSet>
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<StatefulSet>
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): StatefulSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsStatefulSet[]
+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): StatefulSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): StatefulSet

+

Parameters#

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

Returns#

+

StatefulSet

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): StatefulSet[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): StatefulSet

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

StatefulSet

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): StatefulSet

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

StatefulSet

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getChildPods#

+

▸ getChildPods(statefulSet): Pod[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
statefulSetStatefulSet
+

Returns#

+

Pod[]

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): StatefulSet[]

+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ getStatuses(statefulSets): Object

+

Parameters#

+ + + + + + + + + + + + + +
NameType
statefulSetsStatefulSet[]
+

Returns#

+

Object

+ + + + + + + + + + + + + + + + + + + + + +
NameType
failednumber
pendingnumber
runningnumber
+

Overrides#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsStatefulSet[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | StatefulSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | StatefulSet[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<StatefulSet[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<StatefulSet>
+

Returns#

+

Promise<StatefulSet[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): StatefulSet[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsStatefulSet[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStatefulSet
patchPatch
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | StatefulSet[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | StatefulSet[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStatefulSet
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): StatefulSet[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsStatefulSet[]the items to be sorted (default: the current items in this store)
sorting(item: StatefulSet) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

StatefulSet[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsStatefulSet[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStatefulSet
dataPartial<StatefulSet>
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<StatefulSet>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStatefulSet
request() => Promise<StatefulSet>
+

Returns#

+

Promise<StatefulSet>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclass/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclass/index.html new file mode 100644 index 0000000000..01f39cf2cc --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclass/index.html @@ -0,0 +1,1763 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StorageClass - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StorageClass#

+

Renderer.K8sApi.StorageClass

+

Hierarchy#

+ +

↳ StorageClass

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new StorageClass(data)

+

Parameters#

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

Inherited from#

+

KubeObject.constructor

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from#

+

KubeObject.apiVersion

+
+

kind#

+

• kind: string

+

Inherited from#

+

KubeObject.kind

+
+

managedFields#

+

• Optional managedFields: any

+

Inherited from#

+

KubeObject.managedFields

+
+

metadata#

+

• metadata: KubeObjectMetadata

+

Inherited from#

+

KubeObject.metadata

+
+

mountOptions#

+

• Optional mountOptions: string[]

+
+

parameters#

+

• parameters: Object

+

Index signature#

+

▪ [param: string]: string

+
+

provisioner#

+

• provisioner: string

+
+

reclaimPolicy#

+

• reclaimPolicy: string

+
+

spec#

+

• Optional spec: any

+

Inherited from#

+

KubeObject.spec

+
+

status#

+

• Optional status: any

+

Inherited from#

+

KubeObject.status

+
+

volumeBindingMode#

+

• volumeBindingMode: string

+
+

apiBase#

+

▪ Static apiBase: string = "/apis/storage.k8s.io/v1/storageclasses"

+
+

kind#

+

▪ Static kind: string = "StorageClass"

+

Inherited from#

+

KubeObject.kind

+
+

namespaced#

+

▪ Static namespaced: boolean = false

+

Inherited from#

+

KubeObject.namespaced

+

Accessors#

+ +

• get selfLink(): string

+

Returns#

+

string

+

Methods#

+

delete#

+

▸ delete(params?): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams<any>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.delete

+
+

getAge#

+

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

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns#

+

string | number

+

Inherited from#

+

KubeObject.getAge

+
+

getAnnotations#

+

▸ getAnnotations(filter?): string[]

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
filterbooleanfalse
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getAnnotations

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getFinalizers

+
+

getId#

+

▸ getId(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getId

+
+

getLabels#

+

▸ getLabels(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getLabels

+
+

getName#

+

▸ getName(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getName

+
+

getNs#

+

▸ getNs(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getNs

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Returns#

+

{ apiVersion: string ; blockOwnerDeletion: boolean ; controller: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

+

Inherited from#

+

KubeObject.getOwnerRefs

+
+

getReclaimPolicy#

+

▸ getReclaimPolicy(): string

+

Returns#

+

string

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Returns#

+

string

+

Inherited from#

+

KubeObject.getResourceVersion

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.getSearchFields

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObject.getTimeDiffFromNow

+
+

getVolumeBindingMode#

+

▸ getVolumeBindingMode(): string

+

Returns#

+

string

+
+

isDefault#

+

▸ isDefault(): boolean

+

Returns#

+

boolean

+
+

patch#

+

▸ patch(patch): Promise<KubeJsonApiData>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
patchPatch
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.patch

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Returns#

+

object

+

Inherited from#

+

KubeObject.toPlainObject

+
+

update#

+

▸ update(data): Promise<KubeJsonApiData>

+

Perform a full update (or more specifically a replace)

+

Note: this is brittle if data is not actually partial (but instead whole). +As fields such as resourceVersion will probably out of date. This is a +common race condition.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
dataPartial<StorageClass>
+

Returns#

+

Promise<KubeJsonApiData>

+

Inherited from#

+

KubeObject.update

+
+

create#

+

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

+

Parameters#

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

Returns#

+

KubeObject<KubeObjectMetadata, any, any>

+

Inherited from#

+

KubeObject.create

+
+

isJsonApiData#

+

▸ Static isJsonApiData(object): object is KubeJsonApiData

+

Parameters#

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

Returns#

+

object is KubeJsonApiData

+

Inherited from#

+

KubeObject.isJsonApiData

+
+

isJsonApiDataList#

+

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
objectunknown
verifyItem(val: unknown) => val is T
+

Returns#

+

object is KubeJsonApiDataList<T>

+

Inherited from#

+

KubeObject.isJsonApiDataList

+
+

isKubeJsonApiListMetadata#

+

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiListMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiListMetadata

+
+

isKubeJsonApiMetadata#

+

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiMetadata

+

Parameters#

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

Returns#

+

object is KubeJsonApiMetadata

+

Inherited from#

+

KubeObject.isKubeJsonApiMetadata

+
+

isNonSystem#

+

▸ Static isNonSystem(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemKubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData
+

Returns#

+

boolean

+

Inherited from#

+

KubeObject.isNonSystem

+
+

isPartialJsonApiData#

+

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiData>

+

Inherited from#

+

KubeObject.isPartialJsonApiData

+
+

isPartialJsonApiMetadata#

+

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

+

Parameters#

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

Returns#

+

object is Partial<KubeJsonApiMetadata>

+

Inherited from#

+

KubeObject.isPartialJsonApiMetadata

+
+

stringifyLabels#

+

▸ Static stringifyLabels(labels?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labels?Object
+

Returns#

+

string[]

+

Inherited from#

+

KubeObject.stringifyLabels

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html new file mode 100644 index 0000000000..77e2049905 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html @@ -0,0 +1,2367 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StorageClassStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StorageClassStore#

+

Renderer.K8sApi.StorageClassStore

+

Hierarchy#

+ +

↳ StorageClassStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new StorageClassStore()

+

Overrides#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: KubeApi<StorageClass>

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<StorageClass>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<StorageClass, void, undefined>

+

Returns#

+

Generator<StorageClass, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<StorageClass>
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<StorageClass>
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): StorageClass[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsStorageClass[]
+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): StorageClass[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): StorageClass

+

Parameters#

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

Returns#

+

StorageClass

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): StorageClass[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): StorageClass

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

StorageClass

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): StorageClass

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

StorageClass

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): StorageClass[]

+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getPersistentVolumes#

+

▸ getPersistentVolumes(storageClass): PersistentVolume[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
storageClassStorageClass
+

Returns#

+

PersistentVolume[]

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsStorageClass[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsStorageClass[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | StorageClass[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | StorageClass[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<StorageClass[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<StorageClass>
+

Returns#

+

Promise<StorageClass[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): StorageClass[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsStorageClass[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStorageClass
patchPatch
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | StorageClass[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | StorageClass[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStorageClass
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): StorageClass[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsStorageClass[]the items to be sorted (default: the current items in this store)
sorting(item: StorageClass) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

StorageClass[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsStorageClass[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStorageClass
dataPartial<StorageClass>
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<StorageClass>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemStorageClass
request() => Promise<StorageClass>
+

Returns#

+

Promise<StorageClass>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html b/v5.2.6/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html new file mode 100644 index 0000000000..fc8551d3a2 --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html @@ -0,0 +1,2354 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: VolumeClaimStore - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: VolumeClaimStore#

+

Renderer.K8sApi.VolumeClaimStore

+

Hierarchy#

+ +

↳ VolumeClaimStore

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new VolumeClaimStore(api?)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
api?KubeApi<PersistentVolumeClaim>
+

Inherited from#

+

KubeObjectStore.constructor

+

Properties#

+

api#

+

• api: PersistentVolumeClaimsApi

+

Overrides#

+

KubeObjectStore.api

+
+

bufferSize#

+

• Readonly bufferSize: number = 50000

+

Inherited from#

+

KubeObjectStore.bufferSize

+
+

eventsBuffer#

+

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData>>

+

Inherited from#

+

KubeObjectStore.eventsBuffer

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.failedLoading

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoaded

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from#

+

KubeObjectStore.isLoading

+
+

items#

+

• items: IObservableArray<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.items

+
+

limit#

+

• Optional Readonly limit: number

+

Inherited from#

+

KubeObjectStore.limit

+
+

selectedItemsIds#

+

• selectedItemsIds: ObservableMap<string, boolean>

+

Inherited from#

+

KubeObjectStore.selectedItemsIds

+
+

defaultContext#

+

▪ Static defaultContext: IObservableValue<ClusterContext>

+

Inherited from#

+

KubeObjectStore.defaultContext

+

Accessors#

+

context#

+

• get context(): ClusterContext

+

Returns#

+

ClusterContext

+
+

contextItems#

+

• get contextItems(): T[]

+

Returns#

+

T[]

+
+

contextReady#

+

• get contextReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

namespacesReady#

+

• get namespacesReady(): Promise & { cancel: () => void }

+

Returns#

+

Promise & { cancel: () => void }

+
+

query#

+

• get query(): IKubeApiQueryParams

+

Returns#

+

IKubeApiQueryParams

+
+

selectedItems#

+

• get selectedItems(): Item[]

+

Returns#

+

Item[]

+

Methods#

+

[iterator]#

+

▸ [iterator](): Generator<PersistentVolumeClaim, void, undefined>

+

Returns#

+

Generator<PersistentVolumeClaim, void, undefined>

+

Inherited from#

+

KubeObjectStore.[iterator]

+
+

bindWatchEventsUpdater#

+

▸ Protected bindWatchEventsUpdater(delay?): void

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDefault value
delaynumber1000
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.bindWatchEventsUpdater

+
+

create#

+

▸ create(params, data?): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.create

+
+

createItem#

+

▸ Protected createItem(params, data?): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
data?Partial<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.createItem

+
+

defaultSorting#

+

▸ Protected defaultSorting(item): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemItem
+

Returns#

+

string

+

Inherited from#

+

KubeObjectStore.defaultSorting

+
+

filterItemsOnLoad#

+

▸ Protected filterItemsOnLoad(items): PersistentVolumeClaim[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPersistentVolumeClaim[]
+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.filterItemsOnLoad

+
+

getAllByNs#

+

▸ getAllByNs(namespace, strict?): PersistentVolumeClaim[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
namespacestring | string[]undefined
strictbooleanfalse
+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.getAllByNs

+
+

getById#

+

▸ getById(id): PersistentVolumeClaim

+

Parameters#

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

Returns#

+

PersistentVolumeClaim

+

Inherited from#

+

KubeObjectStore.getById

+
+

getByLabel#

+

▸ getByLabel(labels): PersistentVolumeClaim[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
labelsstring[] | { [label: string]: string; }
+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.getByLabel

+
+

getByName#

+

▸ getByName(name, namespace?): PersistentVolumeClaim

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespace?string
+

Returns#

+

PersistentVolumeClaim

+

Inherited from#

+

KubeObjectStore.getByName

+
+

getByPath#

+

▸ getByPath(path): PersistentVolumeClaim

+

Parameters#

+ + + + + + + + + + + + + +
NameType
pathstring
+

Returns#

+

PersistentVolumeClaim

+

Inherited from#

+

KubeObjectStore.getByPath

+
+

getIndexById#

+

▸ getIndexById(id): number

+

Parameters#

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

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getIndexById

+
+

getItems#

+

▸ getItems(): PersistentVolumeClaim[]

+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.getItems

+
+

getStatuses#

+

▸ Optional getStatuses(items): Record<string, number>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemsPersistentVolumeClaim[]
+

Returns#

+

Record<string, number>

+

Inherited from#

+

KubeObjectStore.getStatuses

+
+

getTotalCount#

+

▸ getTotalCount(): number

+

Returns#

+

number

+

Inherited from#

+

KubeObjectStore.getTotalCount

+
+

isSelected#

+

▸ isSelected(item): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelected

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems?): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPersistentVolumeClaim[]
+

Returns#

+

boolean

+

Inherited from#

+

KubeObjectStore.isSelectedAll

+
+

load#

+

▸ load(params): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.load

+
+

loadAll#

+

▸ loadAll(options?): Promise<void | PersistentVolumeClaim[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optionsObject
options.merge?boolean
options.namespaces?string[]
options.reqInit?RequestInit
+

Returns#

+

Promise<void | PersistentVolumeClaim[]>

+

Inherited from#

+

KubeObjectStore.loadAll

+
+

loadFromPath#

+

▸ loadFromPath(resourcePath): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.loadFromPath

+
+

loadItem#

+

▸ Protected loadItem(params): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
paramsObject
params.namestring
params.namespace?string
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.loadItem

+
+

loadItems#

+

▸ Protected loadItems(__namedParameters): Promise<PersistentVolumeClaim[]>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersKubeObjectStoreLoadingParams<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim[]>

+

Inherited from#

+

KubeObjectStore.loadItems

+
+

mergeItems#

+

▸ Protected mergeItems(partialItems, __namedParameters?): PersistentVolumeClaim[]

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
partialItemsPersistentVolumeClaim[]
__namedParametersObject
__namedParameters.filter
__namedParameters.replace
__namedParameters.sort
__namedParameters.updateStore
+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.mergeItems

+
+

patch#

+

▸ patch(item, patch): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
patchPatch
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.patch

+
+

reloadAll#

+

▸ reloadAll(opts?): Promise<void | PersistentVolumeClaim[]>

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
optsObject
opts.force?boolean
opts.merge?boolean
opts.namespaces?string[]
+

Returns#

+

Promise<void | PersistentVolumeClaim[]>

+

Inherited from#

+

KubeObjectStore.reloadAll

+
+

remove#

+

▸ remove(item): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.remove

+
+

removeItem#

+

▸ Protected removeItem(item, request): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
request() => Promise<any>
+

Returns#

+

Promise<void>

+

Inherited from#

+

KubeObjectStore.removeItem

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise<void[]>

+

Returns#

+

Promise<void[]>

+

Inherited from#

+

KubeObjectStore.removeSelectedItems

+
+

reset#

+

▸ reset(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.reset

+
+

resetOnError#

+

▸ Protected resetOnError(error): void

+

Parameters#

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

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetOnError

+
+

resetSelection#

+

▸ resetSelection(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.resetSelection

+
+

select#

+

▸ select(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.select

+
+

sortItems#

+

▸ Protected sortItems(items?, sorting?, order?): PersistentVolumeClaim[]

+

Return items sorted by the given ordering functions. If two elements of +items are sorted to the same "index" then the next sorting function is used +to determine where to place them relative to each other. Once the sorting +functions have been all exhausted then the order is unchanged (ie a stable sort).

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
itemsPersistentVolumeClaim[]the items to be sorted (default: the current items in this store)
sorting(item: PersistentVolumeClaim) => any[]list of functions to determine sort order (default: sorting by name)
order?"desc" | "asc"whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc")
+

Returns#

+

PersistentVolumeClaim[]

+

Inherited from#

+

KubeObjectStore.sortItems

+
+

subscribe#

+

▸ subscribe(): () => void

+

Returns#

+

fn

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

KubeObjectStore.subscribe

+
+

toggleSelection#

+

▸ toggleSelection(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelection

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems?): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
visibleItemsPersistentVolumeClaim[]
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.toggleSelectionAll

+
+

unselect#

+

▸ unselect(item): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.unselect

+
+

update#

+

▸ update(item, data): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
dataPartial<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.update

+
+

updateFromEventsBuffer#

+

▸ Protected updateFromEventsBuffer(): void

+

Returns#

+

void

+

Inherited from#

+

KubeObjectStore.updateFromEventsBuffer

+
+

updateItem#

+

▸ Protected updateItem(item, request): Promise<PersistentVolumeClaim>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
request() => Promise<PersistentVolumeClaim>
+

Returns#

+

Promise<PersistentVolumeClaim>

+

Inherited from#

+

KubeObjectStore.updateItem

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.lensextension/index.html b/v5.2.6/extensions/api/classes/renderer.lensextension/index.html new file mode 100644 index 0000000000..03ebe880db --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.lensextension/index.html @@ -0,0 +1,1418 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LensExtension - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LensExtension#

+

Renderer.LensExtension

+

Hierarchy#

+
    +
  • LensExtension
    • +
+

↳ LensExtension

+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new LensExtension(__namedParameters)

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersInstalledExtension
+

Inherited from#

+

LensExtension.constructor

+

Properties#

+

[Disposers]#

+

• [Disposers]: ExtendableDisposer

+

Inherited from#

+

LensExtension.__@Disposers@24661

+
+

appPreferences#

+

• appPreferences: AppPreferenceRegistration[] = []

+
+

catalogEntityDetailItems#

+

• catalogEntityDetailItems: CatalogEntityDetailRegistration<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>[] = []

+
+

clusterPageMenus#

+

• clusterPageMenus: ClusterPageMenuRegistration[] = []

+
+

clusterPages#

+

• clusterPages: PageRegistration[] = []

+
+

commands#

+

• commands: CommandRegistration[] = []

+
+

entitySettings#

+

• entitySettings: EntitySettingRegistration[] = []

+
+

globalPages#

+

• globalPages: PageRegistration[] = []

+
+

id#

+

• Readonly id: string

+

Inherited from#

+

LensExtension.id

+
+

isBundled#

+

• Readonly isBundled: boolean

+

Inherited from#

+

LensExtension.isBundled

+
+

kubeObjectDetailItems#

+

• kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

+
+

kubeObjectMenuItems#

+

• kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

+
+

kubeObjectStatusTexts#

+

• kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

+
+

kubeWorkloadsOverviewItems#

+

• kubeWorkloadsOverviewItems: WorkloadsOverviewDetailRegistration[] = []

+
+

manifest#

+

• Readonly manifest: LensExtensionManifest

+

Inherited from#

+

LensExtension.manifest

+
+

manifestPath#

+

• Readonly manifestPath: string

+

Inherited from#

+

LensExtension.manifestPath

+
+

protocolHandlers#

+

• protocolHandlers: ProtocolHandlerRegistration[] = []

+

Inherited from#

+

LensExtension.protocolHandlers

+
+

statusBarItems#

+

• statusBarItems: StatusBarRegistration[] = []

+
+

topBarItems#

+

• topBarItems: TopBarRegistration[] = []

+
+

welcomeBanners#

+

• welcomeBanners: WelcomeBannerRegistration[] = []

+
+

welcomeMenus#

+

• welcomeMenus: WelcomeMenuRegistration[] = []

+

Accessors#

+

description#

+

• get description(): string

+

Returns#

+

string

+
+

name#

+

• get name(): string

+

Returns#

+

string

+
+

version#

+

• get version(): string

+

Returns#

+

string

+

Methods#

+

addCatalogFilter#

+

▸ addCatalogFilter(fn): Disposer

+

Add a filtering function for the catalog. This will be removed if the extension is disabled.

+

Parameters#

+ + + + + + + + + + + + + + + +
NameTypeDescription
fnEntityFilterThe function which should return a truthy value for those entities which should be kepted
+

Returns#

+

Disposer

+

A function to clean up the filter

+
+

disable#

+

▸ disable(): Promise<void>

+

Returns#

+

Promise<void>

+

Inherited from#

+

LensExtension.disable

+
+

enable#

+

▸ enable(register): Promise<void>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
register(ext: LensExtension) => Promise<Disposer[]>
+

Returns#

+

Promise<void>

+

Inherited from#

+

LensExtension.enable

+
+

getExtensionFileFolder#

+

▸ getExtensionFileFolder(): Promise<string>

+

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 obfuscation of the +folder name.

+

Returns#

+

Promise<string>

+

Inherited from#

+

LensExtension.getExtensionFileFolder

+
+

isEnabledForCluster#

+

▸ isEnabledForCluster(cluster): Promise<Boolean>

+

Defines if extension is enabled for a given cluster. Defaults to true.

+

Parameters#

+ + + + + + + + + + + + + +
NameType
clusterCluster
+

Returns#

+

Promise<Boolean>

+
+ +

▸ navigate<P>(pageId?, params?): Promise<void>

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
PP: object
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
pageId?string
params?P
+

Returns#

+

Promise<void>

+
+

onActivate#

+

▸ Protected onActivate(): void | Promise<void>

+

Returns#

+

void | Promise<void>

+

Inherited from#

+

LensExtension.onActivate

+
+

onDeactivate#

+

▸ Protected onDeactivate(): void | Promise<void>

+

Returns#

+

void | Promise<void>

+

Inherited from#

+

LensExtension.onDeactivate

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/classes/renderer.navigation.pageparam/index.html b/v5.2.6/extensions/api/classes/renderer.navigation.pageparam/index.html new file mode 100644 index 0000000000..6ab71fd04b --- /dev/null +++ b/v5.2.6/extensions/api/classes/renderer.navigation.pageparam/index.html @@ -0,0 +1,1201 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PageParam - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PageParam<V>#

+

Renderer.Navigation.PageParam

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
VV = any
+

Table of contents#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

• new PageParam<V>(init, history)

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
VV = any
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
initPageParamInit<V>
historyObservableHistory<Object>
+

Properties#

+

isMulti#

+

• Readonly isMulti: boolean

+
+

name#

+

• Readonly name: string

+

Accessors#

+

defaultValue#

+

• get defaultValue(): V

+

Returns#

+

V

+

Methods#

+

clear#

+

▸ clear(): void

+

Returns#

+

void

+
+

get#

+

▸ get(): V

+

Returns#

+

V

+
+

getRaw#

+

▸ getRaw(): string | string[]

+

Get stringified raw value(s) from document.location.search

+

Returns#

+

string | string[]

+
+

parse#

+

▸ parse(values): V

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valuesstring | string[]
+

Returns#

+

V

+
+

set#

+

▸ set(value, __namedParameters?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
valueV
__namedParametersObject
__namedParameters.mergeGlobals
__namedParameters.replaceHistory
+

Returns#

+

void

+
+

setRaw#

+

▸ setRaw(value): void

+

Set stringified raw value(s) and update document.location.search

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valuestring | string[]
+

Returns#

+

void

+
+

stringify#

+

▸ stringify(value?): string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valueV
+

Returns#

+

string[]

+
+

toString#

+

▸ toString(__namedParameters?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
__namedParametersObject
__namedParameters.mergeGlobals
__namedParameters.value
__namedParameters.withPrefix
+

Returns#

+

string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/enums/renderer.component.notificationstatus/index.html b/v5.2.6/extensions/api/enums/renderer.component.notificationstatus/index.html new file mode 100644 index 0000000000..2f889ac489 --- /dev/null +++ b/v5.2.6/extensions/api/enums/renderer.component.notificationstatus/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration: NotificationStatus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Enumeration: NotificationStatus#

+

Renderer.Component.NotificationStatus

+

Table of contents#

+

Enumeration members#

+ +

Enumeration members#

+

ERROR#

+

• ERROR = "error"

+
+

INFO#

+

• INFO = "info"

+
+

OK#

+

• OK = "ok"

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/enums/renderer.component.tooltipposition/index.html b/v5.2.6/extensions/api/enums/renderer.component.tooltipposition/index.html new file mode 100644 index 0000000000..a1dc85c0dd --- /dev/null +++ b/v5.2.6/extensions/api/enums/renderer.component.tooltipposition/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration: TooltipPosition - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Enumeration: TooltipPosition#

+

Renderer.Component.TooltipPosition

+

Table of contents#

+

Enumeration members#

+ +

Enumeration members#

+

BOTTOM#

+

• BOTTOM = "bottom"

+
+

BOTTOM_LEFT#

+

• BOTTOM_LEFT = "bottom_left"

+
+

BOTTOM_RIGHT#

+

• BOTTOM_RIGHT = "bottom_right"

+
+

LEFT#

+

• LEFT = "left"

+
+ +

• RIGHT = "right"

+
+

TOP#

+

• TOP = "top"

+
+

TOP_LEFT#

+

• TOP_LEFT = "top_left"

+
+

TOP_RIGHT#

+

• TOP_RIGHT = "top_right"

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html b/v5.2.6/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html new file mode 100644 index 0000000000..dc5fd691d7 --- /dev/null +++ b/v5.2.6/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration: KubeObjectStatusLevel - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Enumeration: KubeObjectStatusLevel#

+

Renderer.K8sApi.KubeObjectStatusLevel

+

Table of contents#

+

Enumeration members#

+ +

Enumeration members#

+

CRITICAL#

+

• CRITICAL = 3

+
+

INFO#

+

• INFO = 1

+
+

WARNING#

+

• WARNING = 2

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/index.html b/v5.2.6/extensions/api/index.html new file mode 100644 index 0000000000..dfa57890f2 --- /dev/null +++ b/v5.2.6/extensions/api/index.html @@ -0,0 +1,860 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + API Reference - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html new file mode 100644 index 0000000000..58510ae778 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryevents/index.html @@ -0,0 +1,904 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogCategoryEvents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogCategoryEvents#

+

Common.Catalog.CatalogCategoryEvents

+

Table of contents#

+

Properties#

+ +

Properties#

+

catalogAddMenu#

+

• catalogAddMenu: (context: CatalogEntityAddMenuContext) => void

+

Type declaration#

+

▸ (context): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
contextCatalogEntityAddMenuContext
+
Returns#
+

void

+
+

contextMenuOpen#

+

• contextMenuOpen: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>, context: CatalogEntityContextMenuContext) => void

+

Type declaration#

+

▸ (entity, context): void

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
entityCatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
contextCatalogEntityContextMenuContext
+
Returns#
+

void

+
+

load#

+

• load: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html new file mode 100644 index 0000000000..e7c810c7d9 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryspec/index.html @@ -0,0 +1,873 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogCategorySpec - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html new file mode 100644 index 0000000000..8343f084d0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryversion/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogCategoryVersion - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html new file mode 100644 index 0000000000..21ded03cd0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityactioncontext/index.html @@ -0,0 +1,885 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityActionContext - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityActionContext#

+

Common.Catalog.CatalogEntityActionContext

+

Table of contents#

+

Properties#

+ +

Properties#

+ +

• navigate: (url: string) => void

+

Type declaration#

+

▸ (url): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
urlstring
+
Returns#
+

void

+
+

setCommandPaletteContext#

+

• setCommandPaletteContext: (context?: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => void

+

Type declaration#

+

▸ (context?): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
context?CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
+
Returns#
+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html new file mode 100644 index 0000000000..cce82f72b6 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenu/index.html @@ -0,0 +1,923 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityAddMenu - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityAddMenu#

+

Common.Catalog.CatalogEntityAddMenu

+

Hierarchy#

+ +

↳ CatalogEntityAddMenu

+

Table of contents#

+

Properties#

+ +

Properties#

+

confirm#

+

• Optional confirm: Object

+

Confirm click with a message

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
messagestring
+

Inherited from#

+

CatalogEntityContextMenu.confirm

+
+

defaultAction#

+

• Optional defaultAction: boolean

+
+

icon#

+

• icon: string

+

Menu icon

+

Overrides#

+

CatalogEntityContextMenu.icon

+
+

onClick#

+

• onClick: () => void | Promise<void>

+

OnClick handler

+

Type declaration#

+

▸ (): void | Promise<void>

+
Returns#
+

void | Promise<void>

+

Inherited from#

+

CatalogEntityContextMenu.onClick

+
+

title#

+

• title: string

+

Menu title

+

Inherited from#

+

CatalogEntityContextMenu.title

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html new file mode 100644 index 0000000000..7773e8a85c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/index.html @@ -0,0 +1,866 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityAddMenuContext - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityAddMenuContext#

+

Common.Catalog.CatalogEntityAddMenuContext

+

Table of contents#

+

Properties#

+ +

Properties#

+ +

• menuItems: CatalogEntityAddMenu[]

+
+ +

• navigate: (url: string) => void

+

Type declaration#

+

▸ (url): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
urlstring
+
Returns#
+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html new file mode 100644 index 0000000000..b660bb090b --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/index.html @@ -0,0 +1,904 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityContextMenu - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityContextMenu#

+

Common.Catalog.CatalogEntityContextMenu

+

Hierarchy#

+
    +
  • CatalogEntityContextMenu
    • +
+

↳ CatalogEntityAddMenu

+

Table of contents#

+

Properties#

+ +

Properties#

+

confirm#

+

• Optional confirm: Object

+

Confirm click with a message

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
messagestring
+
+

icon#

+

• Optional icon: string

+

Menu icon

+
+

onClick#

+

• onClick: () => void | Promise<void>

+

OnClick handler

+

Type declaration#

+

▸ (): void | Promise<void>

+
Returns#
+

void | Promise<void>

+
+

title#

+

• title: string

+

Menu title

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html new file mode 100644 index 0000000000..729a5b0541 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/index.html @@ -0,0 +1,866 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityContextMenuContext - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityContextMenuContext#

+

Common.Catalog.CatalogEntityContextMenuContext

+

Table of contents#

+

Properties#

+ +

Properties#

+ +

• menuItems: CatalogEntityContextMenu[]

+
+ +

• navigate: (url: string) => void

+

Type declaration#

+

▸ (url): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
urlstring
+
Returns#
+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitydata/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitydata/index.html new file mode 100644 index 0000000000..b2a2ad240c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitydata/index.html @@ -0,0 +1,888 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityData - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityData<Metadata, Status, Spec>#

+

Common.Catalog.CatalogEntityData

+

Type parameters#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
MetadataMetadata: CatalogEntityMetadata = CatalogEntityMetadata
StatusStatus: CatalogEntityStatus = CatalogEntityStatus
SpecSpec: CatalogEntitySpec = CatalogEntitySpec
+

Table of contents#

+

Properties#

+ +

Properties#

+

metadata#

+

• metadata: Metadata

+
+

spec#

+

• spec: Spec

+
+

status#

+

• status: Status

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html new file mode 100644 index 0000000000..5bae0e86b3 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitykinddata/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityKindData - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityKindData#

+

Common.Catalog.CatalogEntityKindData

+

Implemented by#

+ +

Table of contents#

+

Properties#

+ +

Properties#

+

apiVersion#

+

• Readonly apiVersion: string

+
+

kind#

+

• Readonly kind: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html new file mode 100644 index 0000000000..43787d7910 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitymetadata/index.html @@ -0,0 +1,901 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityMetadata - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityMetadata#

+

Common.Catalog.CatalogEntityMetadata

+

Hierarchy#

+
    +
  • CatalogEntityMetadata
    • +
+

↳ KubernetesClusterMetadata

+

Indexable#

+

▪ [key: string]: string | object

+

Table of contents#

+

Properties#

+ +

Properties#

+

description#

+

• Optional description: string

+
+

labels#

+

• labels: Record<string, string>

+
+

name#

+

• name: string

+
+

source#

+

• Optional source: string

+
+

uid#

+

• uid: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html new file mode 100644 index 0000000000..156819683b --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntitySettingsContext - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html new file mode 100644 index 0000000000..8a0b300269 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/index.html @@ -0,0 +1,873 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntitySettingsMenu - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntitySettingsMenu#

+

Common.Catalog.CatalogEntitySettingsMenu

+

Table of contents#

+

Properties#

+ +

Properties#

+

components#

+

• components: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
ViewComponentType<any>
+
+

group#

+

• Optional group: string

+
+

title#

+

• title: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html new file mode 100644 index 0000000000..6c1824606a --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitystatus/index.html @@ -0,0 +1,894 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CatalogEntityStatus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CatalogEntityStatus#

+

Common.Catalog.CatalogEntityStatus

+

Hierarchy#

+
    +
  • CatalogEntityStatus
    • +
+

↳ KubernetesClusterStatus

+

↳ WebLinkStatus

+

Table of contents#

+

Properties#

+ +

Properties#

+

active#

+

• Optional active: boolean

+
+

enabled#

+

• Optional enabled: boolean

+

default true

+
+

message#

+

• Optional message: string

+
+

phase#

+

• phase: string

+
+

reason#

+

• Optional reason: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html new file mode 100644 index 0000000000..8fd1474516 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/index.html @@ -0,0 +1,924 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubernetesClusterMetadata - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubernetesClusterMetadata#

+

Common.Catalog.KubernetesClusterMetadata

+

Hierarchy#

+ +

↳ KubernetesClusterMetadata

+

Table of contents#

+

Properties#

+ +

Properties#

+

description#

+

• Optional description: string

+

Inherited from#

+

CatalogEntityMetadata.description

+
+

distro#

+

• Optional distro: string

+
+

kubeVersion#

+

• Optional kubeVersion: string

+
+

labels#

+

• labels: Record<string, string>

+

Inherited from#

+

CatalogEntityMetadata.labels

+
+

name#

+

• name: string

+

Inherited from#

+

CatalogEntityMetadata.name

+
+

source#

+

• Optional source: string

+

Inherited from#

+

CatalogEntityMetadata.source

+
+

uid#

+

• uid: string

+

Inherited from#

+

CatalogEntityMetadata.uid

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html new file mode 100644 index 0000000000..f1934698df --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/index.html @@ -0,0 +1,874 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubernetesClusterPrometheusMetrics - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubernetesClusterPrometheusMetrics#

+

Common.Catalog.KubernetesClusterPrometheusMetrics

+

Table of contents#

+

Properties#

+ +

Properties#

+

address#

+

• Optional address: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
namespacestring
portnumber
prefixstring
servicestring
+
+

type#

+

• Optional type: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html new file mode 100644 index 0000000000..599913a1ab --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterspec/index.html @@ -0,0 +1,934 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubernetesClusterSpec - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubernetesClusterSpec#

+

Common.Catalog.KubernetesClusterSpec

+

Hierarchy#

+ +

↳ KubernetesClusterSpec

+

Table of contents#

+

Properties#

+ +

Properties#

+

accessibleNamespaces#

+

• Optional accessibleNamespaces: string[]

+
+

icon#

+

• Optional icon: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
background?string
material?string
src?string
+
+

kubeconfigContext#

+

• kubeconfigContext: string

+
+

kubeconfigPath#

+

• kubeconfigPath: string

+
+

metrics#

+

• Optional metrics: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
prometheus?KubernetesClusterPrometheusMetrics
sourcestring
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html new file mode 100644 index 0000000000..2334bd2924 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/index.html @@ -0,0 +1,903 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubernetesClusterStatus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubernetesClusterStatus#

+

Common.Catalog.KubernetesClusterStatus

+

Hierarchy#

+ +

↳ KubernetesClusterStatus

+

Table of contents#

+

Properties#

+ +

Properties#

+

active#

+

• Optional active: boolean

+

Inherited from#

+

CatalogEntityStatus.active

+
+

enabled#

+

• Optional enabled: boolean

+

default true

+

Inherited from#

+

CatalogEntityStatus.enabled

+
+

message#

+

• Optional message: string

+

Inherited from#

+

CatalogEntityStatus.message

+
+

phase#

+

• phase: KubernetesClusterStatusPhase

+

Overrides#

+

CatalogEntityStatus.phase

+
+

reason#

+

• Optional reason: string

+

Inherited from#

+

CatalogEntityStatus.reason

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.catalog.weblinkstatus/index.html b/v5.2.6/extensions/api/interfaces/common.catalog.weblinkstatus/index.html new file mode 100644 index 0000000000..187c799868 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.catalog.weblinkstatus/index.html @@ -0,0 +1,903 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: WebLinkStatus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: WebLinkStatus#

+

Common.Catalog.WebLinkStatus

+

Hierarchy#

+ +

↳ WebLinkStatus

+

Table of contents#

+

Properties#

+ +

Properties#

+

active#

+

• Optional active: boolean

+

Inherited from#

+

CatalogEntityStatus.active

+
+

enabled#

+

• Optional enabled: boolean

+

default true

+

Inherited from#

+

CatalogEntityStatus.enabled

+
+

message#

+

• Optional message: string

+

Inherited from#

+

CatalogEntityStatus.message

+
+

phase#

+

• phase: WebLinkStatusPhase

+

Overrides#

+

CatalogEntityStatus.phase

+
+

reason#

+

• Optional reason: string

+

Inherited from#

+

CatalogEntityStatus.reason

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.apppreferencecomponents/index.html b/v5.2.6/extensions/api/interfaces/common.types.apppreferencecomponents/index.html new file mode 100644 index 0000000000..fa6b91fe62 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.apppreferencecomponents/index.html @@ -0,0 +1,862 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceComponents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: AppPreferenceComponents#

+

Common.Types.AppPreferenceComponents

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Table of contents#

+

Properties#

+ +

Properties#

+

Hint#

+

• Hint: ComponentType<any>

+
+

Input#

+

• Input: ComponentType<any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.apppreferenceregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.apppreferenceregistration/index.html new file mode 100644 index 0000000000..74886015a6 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.apppreferenceregistration/index.html @@ -0,0 +1,884 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: AppPreferenceRegistration#

+

Common.Types.AppPreferenceRegistration

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Table of contents#

+

Properties#

+ +

Properties#

+

components#

+

• components: AppPreferenceComponents

+
+

id#

+

• Optional id: string

+
+

showInPreferencesTab#

+

• Optional showInPreferencesTab: string

+
+

title#

+

• title: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html b/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html new file mode 100644 index 0000000000..34f823bd29 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenucomponents/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterPageMenuComponents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ClusterPageMenuComponents#

+

Common.Types.ClusterPageMenuComponents

+

Table of contents#

+

Properties#

+ +

Properties#

+

Icon#

+

• Icon: ComponentType<IconProps>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html new file mode 100644 index 0000000000..673803ca95 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html @@ -0,0 +1,880 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterPageMenuRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html new file mode 100644 index 0000000000..9a4e5f93b8 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailComponents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html new file mode 100644 index 0000000000..6f37df3e33 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailregistration/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html new file mode 100644 index 0000000000..2d23340f9d --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenucomponents/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuComponents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeObjectMenuComponents#

+

Common.Types.KubeObjectMenuComponents

+

Table of contents#

+

Properties#

+ +

Properties#

+ +

• MenuItem: ComponentType<any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html new file mode 100644 index 0000000000..1e756f9032 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenuregistration/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html new file mode 100644 index 0000000000..ab2ddd3898 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.kubeobjectstatusregistration/index.html @@ -0,0 +1,877 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectStatusRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.pagecomponentprops/index.html b/v5.2.6/extensions/api/interfaces/common.types.pagecomponentprops/index.html new file mode 100644 index 0000000000..8c4f9ae197 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.pagecomponentprops/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponentProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageComponentProps<P>#

+

Common.Types.PageComponentProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
PP: PageParams = {}
+

Table of contents#

+

Properties#

+ +

Properties#

+

params#

+

• Optional params: { [N in string | number | symbol]: PageParam<P[N]>}

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.pagecomponents/index.html b/v5.2.6/extensions/api/interfaces/common.types.pagecomponents/index.html new file mode 100644 index 0000000000..21cf644dd9 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.pagecomponents/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponents - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageComponents#

+

Common.Types.PageComponents

+

Table of contents#

+

Properties#

+ +

Properties#

+

Page#

+

• Page: ComponentType<any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.pageparams/index.html b/v5.2.6/extensions/api/interfaces/common.types.pageparams/index.html new file mode 100644 index 0000000000..9ae63e0e86 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.pageparams/index.html @@ -0,0 +1,819 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageParams<V>#

+

Common.Types.PageParams

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
VV = any
+

Indexable#

+

▪ [paramName: string]: V

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.pageregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.pageregistration/index.html new file mode 100644 index 0000000000..274a55b8a8 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.pageregistration/index.html @@ -0,0 +1,860 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageRegistration#

+

Common.Types.PageRegistration

+

Table of contents#

+

Properties#

+ +

Properties#

+

components#

+

• components: PageComponents

+
+

id#

+

• Optional id: string

+

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

+
+

params#

+

• Optional params: PageParams<string | Omit<PageParamInit<any>, "name" | "prefix">>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.pagetarget/index.html b/v5.2.6/extensions/api/interfaces/common.types.pagetarget/index.html new file mode 100644 index 0000000000..04d51578de --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.pagetarget/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageTarget - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageTarget#

+

Common.Types.PageTarget

+

Table of contents#

+

Properties#

+ +

Properties#

+

extensionId#

+

• Optional extensionId: string

+
+

pageId#

+

• Optional pageId: string

+
+

params#

+

• Optional params: PageParams<any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html new file mode 100644 index 0000000000..dd98a38376 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.protocolhandlerregistration/index.html @@ -0,0 +1,849 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ProtocolHandlerRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ProtocolHandlerRegistration#

+

Common.Types.ProtocolHandlerRegistration

+

ProtocolHandlerRegistration is the data required for an extension to register +a handler to a specific path or dynamic path.

+

Table of contents#

+

Properties#

+ +

Properties#

+

handler#

+

• handler: ProtocolRouteHandler

+
+

pathSchema#

+

• pathSchema: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.protocolroutehandler/index.html b/v5.2.6/extensions/api/interfaces/common.types.protocolroutehandler/index.html new file mode 100644 index 0000000000..f1590882c2 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.protocolroutehandler/index.html @@ -0,0 +1,832 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ProtocolRouteHandler - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ProtocolRouteHandler#

+

Common.Types.ProtocolRouteHandler

+

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

+

Callable#

+

ProtocolRouteHandler#

+

▸ ProtocolRouteHandler(params): void

+

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

+

Parameters#

+ + + + + + + + + + + + + +
NameType
paramsProtocolRouteParams
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.protocolrouteparams/index.html b/v5.2.6/extensions/api/interfaces/common.types.protocolrouteparams/index.html new file mode 100644 index 0000000000..8339a0ca1e --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.protocolrouteparams/index.html @@ -0,0 +1,868 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ProtocolRouteParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ProtocolRouteParams#

+

Common.Types.ProtocolRouteParams

+

The collection of the dynamic parts of a URI which initiated a lens:// +protocol request

+

Table of contents#

+

Properties#

+ +

Properties#

+

pathname#

+

• pathname: Record<string, string>

+

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

+
+ +

• search: Record<string, string>

+

the parts of the URI query string

+
+

tail#

+

• Optional tail: string

+

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/v5.2.6/extensions/api/interfaces/common.types.registeredpage/index.html b/v5.2.6/extensions/api/interfaces/common.types.registeredpage/index.html new file mode 100644 index 0000000000..6b3acf9e09 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.registeredpage/index.html @@ -0,0 +1,880 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: RegisteredPage - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/common.types.statusbarregistration/index.html b/v5.2.6/extensions/api/interfaces/common.types.statusbarregistration/index.html new file mode 100644 index 0000000000..1adb9e0aa2 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/common.types.statusbarregistration/index.html @@ -0,0 +1,862 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBarRegistration - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: StatusBarRegistration#

+

Common.Types.StatusBarRegistration

+

Hierarchy#

+
    +
  • StatusBarRegistrationV2
    • +
+

↳ StatusBarRegistration

+

Table of contents#

+

Properties#

+ +

Properties#

+

components#

+

• Optional components: StatusBarComponents

+

Inherited from#

+

StatusBarRegistrationV2.components

+
+

item#

+

• Optional item: ReactNode

+

deprecated use components.Item instead

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.badgeprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.badgeprops/index.html new file mode 100644 index 0000000000..d737e80bf2 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.badgeprops/index.html @@ -0,0 +1,4324 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: BadgeProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: BadgeProps#

+

Renderer.Component.BadgeProps

+

Hierarchy#

+ +

↳ BadgeProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLAttributes.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLAttributes.accessKey

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLAttributes.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLAttributes.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLAttributes.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLAttributes.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLAttributes.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLAttributes.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLAttributes.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLAttributes.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLAttributes.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLAttributes.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLAttributes.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLAttributes.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLAttributes.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLAttributes.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLAttributes.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLAttributes.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLAttributes.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLAttributes.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLAttributes.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLAttributes.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLAttributes.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLAttributes.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLAttributes.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLAttributes.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLAttributes.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLAttributes.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLAttributes.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLAttributes.autoSave

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLAttributes.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLAttributes.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLAttributes.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLAttributes.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLAttributes.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLAttributes.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLAttributes.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLAttributes.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLAttributes.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLAttributes.dir

+
+

disabled#

+

• Optional disabled: boolean

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLAttributes.draggable

+
+

expandable#

+

• Optional expandable: boolean

+
+

flat#

+

• Optional flat: boolean

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLAttributes.hidden

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLAttributes.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLAttributes.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLAttributes.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLAttributes.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLAttributes.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLAttributes.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLAttributes.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLAttributes.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLAttributes.itemType

+
+

label#

+

• Optional label: ReactNode

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLAttributes.lang

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheelCapture

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLAttributes.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLAttributes.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLAttributes.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLAttributes.radioGroup

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLAttributes.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLAttributes.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLAttributes.role

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLAttributes.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLAttributes.slot

+
+

small#

+

• Optional small: boolean

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLAttributes.spellCheck

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLAttributes.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLAttributes.tabIndex

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLAttributes.title

+
+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+

Inherited from#

+

TooltipDecoratorProps.tooltip

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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

+

Inherited from#

+

TooltipDecoratorProps.tooltipOverrideDisabled

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLAttributes.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLAttributes.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLAttributes.unselectable

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLAttributes.vocab

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.buttonprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.buttonprops/index.html new file mode 100644 index 0000000000..d0a117b480 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.buttonprops/index.html @@ -0,0 +1,4544 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ButtonProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ButtonProps#

+

Renderer.Component.ButtonProps

+

Hierarchy#

+ +

↳ ButtonProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

ButtonHTMLAttributes.about

+
+

accent#

+

• Optional accent: boolean

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

ButtonHTMLAttributes.accessKey

+
+

active#

+

• Optional active: boolean

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

ButtonHTMLAttributes.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

ButtonHTMLAttributes.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

ButtonHTMLAttributes.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

ButtonHTMLAttributes.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

ButtonHTMLAttributes.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

ButtonHTMLAttributes.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

ButtonHTMLAttributes.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

ButtonHTMLAttributes.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

ButtonHTMLAttributes.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

ButtonHTMLAttributes.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

ButtonHTMLAttributes.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

ButtonHTMLAttributes.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

ButtonHTMLAttributes.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

ButtonHTMLAttributes.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

ButtonHTMLAttributes.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

ButtonHTMLAttributes.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

ButtonHTMLAttributes.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

ButtonHTMLAttributes.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

ButtonHTMLAttributes.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

ButtonHTMLAttributes.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

ButtonHTMLAttributes.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

ButtonHTMLAttributes.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

ButtonHTMLAttributes.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

ButtonHTMLAttributes.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

ButtonHTMLAttributes.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

ButtonHTMLAttributes.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

ButtonHTMLAttributes.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

ButtonHTMLAttributes.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

ButtonHTMLAttributes.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

ButtonHTMLAttributes.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

ButtonHTMLAttributes.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

ButtonHTMLAttributes.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

ButtonHTMLAttributes.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

ButtonHTMLAttributes.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

ButtonHTMLAttributes.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

ButtonHTMLAttributes.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

ButtonHTMLAttributes.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

ButtonHTMLAttributes.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

ButtonHTMLAttributes.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

ButtonHTMLAttributes.autoCorrect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

ButtonHTMLAttributes.autoFocus

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

ButtonHTMLAttributes.autoSave

+
+

big#

+

• Optional big: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

ButtonHTMLAttributes.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

ButtonHTMLAttributes.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

ButtonHTMLAttributes.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

ButtonHTMLAttributes.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

ButtonHTMLAttributes.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

ButtonHTMLAttributes.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

ButtonHTMLAttributes.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

ButtonHTMLAttributes.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

ButtonHTMLAttributes.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

ButtonHTMLAttributes.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Inherited from#

+

ButtonHTMLAttributes.disabled

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

ButtonHTMLAttributes.draggable

+
+

form#

+

• Optional form: string

+

Inherited from#

+

ButtonHTMLAttributes.form

+
+

formAction#

+

• Optional formAction: string

+

Inherited from#

+

ButtonHTMLAttributes.formAction

+
+

formEncType#

+

• Optional formEncType: string

+

Inherited from#

+

ButtonHTMLAttributes.formEncType

+
+

formMethod#

+

• Optional formMethod: string

+

Inherited from#

+

ButtonHTMLAttributes.formMethod

+
+

formNoValidate#

+

• Optional formNoValidate: boolean

+

Inherited from#

+

ButtonHTMLAttributes.formNoValidate

+
+

formTarget#

+

• Optional formTarget: string

+

Inherited from#

+

ButtonHTMLAttributes.formTarget

+
+

hidden#

+

• Optional hidden: boolean

+

Overrides#

+

ButtonHTMLAttributes.hidden

+
+

href#

+

• Optional href: string

+
+

id#

+

• Optional id: string

+

Inherited from#

+

ButtonHTMLAttributes.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

ButtonHTMLAttributes.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

ButtonHTMLAttributes.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

ButtonHTMLAttributes.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

ButtonHTMLAttributes.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

ButtonHTMLAttributes.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

ButtonHTMLAttributes.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

ButtonHTMLAttributes.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

ButtonHTMLAttributes.itemType

+
+

label#

+

• Optional label: ReactNode

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

ButtonHTMLAttributes.lang

+
+

light#

+

• Optional light: boolean

+
+

name#

+

• Optional name: string

+

Inherited from#

+

ButtonHTMLAttributes.name

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

ButtonHTMLAttributes.onWheelCapture

+
+

outlined#

+

• Optional outlined: boolean

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

ButtonHTMLAttributes.placeholder

+
+

plain#

+

• Optional plain: boolean

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

ButtonHTMLAttributes.prefix

+
+

primary#

+

• Optional primary: boolean

+
+

property#

+

• Optional property: string

+

Inherited from#

+

ButtonHTMLAttributes.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

ButtonHTMLAttributes.radioGroup

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

ButtonHTMLAttributes.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

ButtonHTMLAttributes.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

ButtonHTMLAttributes.role

+
+

round#

+

• Optional round: boolean

+
+

security#

+

• Optional security: string

+

Inherited from#

+

ButtonHTMLAttributes.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

ButtonHTMLAttributes.slot

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

ButtonHTMLAttributes.spellCheck

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

ButtonHTMLAttributes.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

ButtonHTMLAttributes.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

ButtonHTMLAttributes.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

ButtonHTMLAttributes.tabIndex

+
+

target#

+

• Optional target: "_blank"

+
+

title#

+

• Optional title: string

+

Inherited from#

+

ButtonHTMLAttributes.title

+
+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+

Inherited from#

+

TooltipDecoratorProps.tooltip

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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

+

Inherited from#

+

TooltipDecoratorProps.tooltipOverrideDisabled

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

ButtonHTMLAttributes.translate

+
+

type#

+

• Optional type: "submit" | "reset" | "button"

+

Inherited from#

+

ButtonHTMLAttributes.type

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

ButtonHTMLAttributes.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

ButtonHTMLAttributes.unselectable

+
+

value#

+

• Optional value: string | number | readonly string[]

+

Inherited from#

+

ButtonHTMLAttributes.value

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

ButtonHTMLAttributes.vocab

+
+

waiting#

+

• Optional waiting: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.checkboxprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.checkboxprops/index.html new file mode 100644 index 0000000000..ace9e81d66 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.checkboxprops/index.html @@ -0,0 +1,968 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CheckboxProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: CheckboxProps<T>#

+

Renderer.Component.CheckboxProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT = boolean
+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

className#

+

• Optional className: string

+
+

disabled#

+

• Optional disabled: boolean

+
+

inline#

+

• Optional inline: boolean

+
+

label#

+

• Optional label: ReactNode

+
+

theme#

+

• Optional theme: "light" | "dark"

+
+

value#

+

• Optional value: T

+

Methods#

+

onChange#

+

▸ Optional onChange(value, evt): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
valueT
evtChangeEvent<HTMLInputElement>
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html new file mode 100644 index 0000000000..9b41ac6d84 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/index.html @@ -0,0 +1,903 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogBooleanParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogBooleanParams#

+

Renderer.Component.ConfirmDialogBooleanParams

+

Hierarchy#

+
    +
  • ConfirmDialogBooleanParams
    • +
+

↳ ConfirmDialogParams

+

Table of contents#

+

Properties#

+ +

Properties#

+

cancelButtonProps#

+

• Optional cancelButtonProps: Partial<ButtonProps>

+
+

icon#

+

• Optional icon: ReactNode

+
+

labelCancel#

+

• Optional labelCancel: ReactNode

+
+

labelOk#

+

• Optional labelOk: ReactNode

+
+

message#

+

• message: ReactNode

+
+

okButtonProps#

+

• Optional okButtonProps: Partial<ButtonProps>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html new file mode 100644 index 0000000000..eaddcbf3b3 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogparams/index.html @@ -0,0 +1,945 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogParams#

+

Renderer.Component.ConfirmDialogParams

+

Hierarchy#

+ +

↳ ConfirmDialogParams

+

Table of contents#

+

Properties#

+ +

Properties#

+

cancel#

+

• Optional cancel: () => any

+

Type declaration#

+

▸ (): any

+
Returns#
+

any

+
+

cancelButtonProps#

+

• Optional cancelButtonProps: Partial<ButtonProps>

+

Inherited from#

+

ConfirmDialogBooleanParams.cancelButtonProps

+
+

icon#

+

• Optional icon: ReactNode

+

Inherited from#

+

ConfirmDialogBooleanParams.icon

+
+

labelCancel#

+

• Optional labelCancel: ReactNode

+

Inherited from#

+

ConfirmDialogBooleanParams.labelCancel

+
+

labelOk#

+

• Optional labelOk: ReactNode

+

Inherited from#

+

ConfirmDialogBooleanParams.labelOk

+
+

message#

+

• message: ReactNode

+

Inherited from#

+

ConfirmDialogBooleanParams.message

+
+

ok#

+

• Optional ok: () => any

+

Type declaration#

+

▸ (): any

+
Returns#
+

any

+
+

okButtonProps#

+

• Optional okButtonProps: Partial<ButtonProps>

+

Inherited from#

+

ConfirmDialogBooleanParams.okButtonProps

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html new file mode 100644 index 0000000000..345e2dc931 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogprops/index.html @@ -0,0 +1,970 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogProps#

+

Renderer.Component.ConfirmDialogProps

+

Hierarchy#

+ +

↳ ConfirmDialogProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

animated#

+

• Optional animated: boolean

+

Inherited from#

+

Partial.animated

+
+

className#

+

• Optional className: string

+

Inherited from#

+

Partial.className

+
+

close#

+

• Optional close: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

Partial.close

+
+

isOpen#

+

• Optional isOpen: boolean

+

Inherited from#

+

Partial.isOpen

+
+ +

• Optional modal: boolean

+

Inherited from#

+

Partial.modal

+
+

onClose#

+

• Optional onClose: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

Partial.onClose

+
+

onOpen#

+

• Optional onOpen: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

Partial.onOpen

+
+

open#

+

• Optional open: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

Partial.open

+
+

pinned#

+

• Optional pinned: boolean

+

Inherited from#

+

Partial.pinned

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.dialogprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.dialogprops/index.html new file mode 100644 index 0000000000..f66df91ebb --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.dialogprops/index.html @@ -0,0 +1,940 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DialogProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DialogProps#

+

Renderer.Component.DialogProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

animated#

+

• Optional animated: boolean

+
+

className#

+

• Optional className: string

+
+

close#

+

• Optional close: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

isOpen#

+

• Optional isOpen: boolean

+
+ +

• Optional modal: boolean

+
+

onClose#

+

• Optional onClose: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

onOpen#

+

• Optional onOpen: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

open#

+

• Optional open: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

pinned#

+

• Optional pinned: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html new file mode 100644 index 0000000000..7e98868775 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html @@ -0,0 +1,4286 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemLabelsProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DrawerItemLabelsProps#

+

Renderer.Component.DrawerItemLabelsProps

+

Hierarchy#

+ +

↳ DrawerItemLabelsProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

DrawerItemProps.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

DrawerItemProps.accessKey

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

DrawerItemProps.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

DrawerItemProps.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

DrawerItemProps.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

DrawerItemProps.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

DrawerItemProps.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

DrawerItemProps.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

DrawerItemProps.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

DrawerItemProps.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

DrawerItemProps.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

DrawerItemProps.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

DrawerItemProps.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

DrawerItemProps.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

DrawerItemProps.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

DrawerItemProps.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

DrawerItemProps.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

DrawerItemProps.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

DrawerItemProps.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

DrawerItemProps.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

DrawerItemProps.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

DrawerItemProps.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

DrawerItemProps.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

DrawerItemProps.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

DrawerItemProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

DrawerItemProps.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

DrawerItemProps.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

DrawerItemProps.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

DrawerItemProps.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

DrawerItemProps.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

DrawerItemProps.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

DrawerItemProps.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

DrawerItemProps.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

DrawerItemProps.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

DrawerItemProps.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

DrawerItemProps.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

DrawerItemProps.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

DrawerItemProps.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

DrawerItemProps.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

DrawerItemProps.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

DrawerItemProps.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

DrawerItemProps.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

DrawerItemProps.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

DrawerItemProps.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

DrawerItemProps.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

DrawerItemProps.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

DrawerItemProps.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

DrawerItemProps.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

DrawerItemProps.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

DrawerItemProps.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

DrawerItemProps.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

DrawerItemProps.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

DrawerItemProps.autoSave

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

DrawerItemProps.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

DrawerItemProps.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

DrawerItemProps.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

DrawerItemProps.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

DrawerItemProps.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

DrawerItemProps.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

DrawerItemProps.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

DrawerItemProps.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

DrawerItemProps.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

DrawerItemProps.dir

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

DrawerItemProps.draggable

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

DrawerItemProps.hidden

+
+

id#

+

• Optional id: string

+

Inherited from#

+

DrawerItemProps.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

DrawerItemProps.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

DrawerItemProps.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

DrawerItemProps.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

DrawerItemProps.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

DrawerItemProps.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

DrawerItemProps.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

DrawerItemProps.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

DrawerItemProps.itemType

+
+

labels#

+

• labels: string[]

+
+

labelsOnly#

+

• Optional labelsOnly: boolean

+

Inherited from#

+

DrawerItemProps.labelsOnly

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

DrawerItemProps.lang

+
+

name#

+

• name: ReactNode

+

Inherited from#

+

DrawerItemProps.name

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

DrawerItemProps.onWheelCapture

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

DrawerItemProps.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

DrawerItemProps.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

DrawerItemProps.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

DrawerItemProps.radioGroup

+
+

renderBoolean#

+

• Optional renderBoolean: boolean

+

Inherited from#

+

DrawerItemProps.renderBoolean

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

DrawerItemProps.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

DrawerItemProps.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

DrawerItemProps.role

+
+

security#

+

• Optional security: string

+

Inherited from#

+

DrawerItemProps.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

DrawerItemProps.slot

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

DrawerItemProps.spellCheck

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

DrawerItemProps.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

DrawerItemProps.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

DrawerItemProps.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

DrawerItemProps.tabIndex

+
+

title#

+

• Optional title: string

+

Inherited from#

+

DrawerItemProps.title

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

DrawerItemProps.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

DrawerItemProps.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

DrawerItemProps.unselectable

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

DrawerItemProps.vocab

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.draweritemprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.draweritemprops/index.html new file mode 100644 index 0000000000..e41d62cad3 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.draweritemprops/index.html @@ -0,0 +1,4270 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DrawerItemProps#

+

Renderer.Component.DrawerItemProps

+

Hierarchy#

+
    +
  • HTMLAttributes<any>
    • +
+

↳ DrawerItemProps

+

↳↳ DrawerItemLabelsProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLAttributes.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLAttributes.accessKey

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLAttributes.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLAttributes.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLAttributes.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLAttributes.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLAttributes.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLAttributes.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLAttributes.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLAttributes.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLAttributes.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLAttributes.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLAttributes.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLAttributes.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLAttributes.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLAttributes.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLAttributes.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLAttributes.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLAttributes.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLAttributes.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLAttributes.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLAttributes.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLAttributes.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLAttributes.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLAttributes.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLAttributes.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLAttributes.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLAttributes.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLAttributes.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLAttributes.autoSave

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLAttributes.children

+
+

className#

+

• Optional className: string

+

Overrides#

+

React.HTMLAttributes.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLAttributes.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLAttributes.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLAttributes.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLAttributes.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLAttributes.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLAttributes.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLAttributes.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLAttributes.dir

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLAttributes.draggable

+
+

hidden#

+

• Optional hidden: boolean

+

Overrides#

+

React.HTMLAttributes.hidden

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLAttributes.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLAttributes.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLAttributes.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLAttributes.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLAttributes.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLAttributes.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLAttributes.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLAttributes.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLAttributes.itemType

+
+

labelsOnly#

+

• Optional labelsOnly: boolean

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLAttributes.lang

+
+

name#

+

• name: ReactNode

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheelCapture

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLAttributes.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLAttributes.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLAttributes.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLAttributes.radioGroup

+
+

renderBoolean#

+

• Optional renderBoolean: boolean

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLAttributes.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLAttributes.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLAttributes.role

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLAttributes.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLAttributes.slot

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLAttributes.spellCheck

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLAttributes.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLAttributes.tabIndex

+
+

title#

+

• Optional title: string

+

Overrides#

+

React.HTMLAttributes.title

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLAttributes.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLAttributes.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLAttributes.unselectable

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLAttributes.vocab

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html new file mode 100644 index 0000000000..e3103c8921 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerParamTogglerProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DrawerParamTogglerProps#

+

Renderer.Component.DrawerParamTogglerProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

label#

+

• label: string | number

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.drawerprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.drawerprops/index.html new file mode 100644 index 0000000000..7ae977bea4 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.drawerprops/index.html @@ -0,0 +1,939 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DrawerProps#

+

Renderer.Component.DrawerProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

animation#

+

• Optional animation: string

+
+

className#

+

• Optional className: string | object

+
+

contentClass#

+

• Optional contentClass: string | object

+
+

onClose#

+

• Optional onClose: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

open#

+

• open: boolean

+
+

position#

+

• Optional position: "bottom" | "top" | "left" | "right"

+
+

size#

+

• Optional size: string

+
+

title#

+

• title: ReactNode

+
+

toolbar#

+

• Optional toolbar: ReactNode

+
+

usePortal#

+

• Optional usePortal: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.drawertitleprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.drawertitleprops/index.html new file mode 100644 index 0000000000..deea750e4f --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.drawertitleprops/index.html @@ -0,0 +1,847 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerTitleProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: DrawerTitleProps#

+

Renderer.Component.DrawerTitleProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

className#

+

• Optional className: string

+
+

title#

+

• Optional title: ReactNode

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.groupselectoption/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.groupselectoption/index.html new file mode 100644 index 0000000000..d00c2ee126 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.groupselectoption/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: GroupSelectOption - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: GroupSelectOption<T>#

+

Renderer.Component.GroupSelectOption

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: SelectOption = SelectOption
+

Table of contents#

+

Properties#

+ +

Properties#

+

label#

+

• label: ReactNode

+
+

options#

+

• options: T[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.icondatafnarg/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.icondatafnarg/index.html new file mode 100644 index 0000000000..b3902a2ed9 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.icondatafnarg/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IconDataFnArg - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IconDataFnArg#

+

Renderer.Component.IconDataFnArg

+

Table of contents#

+

Properties#

+ +

Properties#

+

isDirty#

+

• isDirty: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.iconprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.iconprops/index.html new file mode 100644 index 0000000000..45ecefb944 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.iconprops/index.html @@ -0,0 +1,4412 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IconProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IconProps#

+

Renderer.Component.IconProps

+

Hierarchy#

+ +

↳ IconProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLAttributes.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLAttributes.accessKey

+
+

active#

+

• Optional active: boolean

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLAttributes.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLAttributes.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLAttributes.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLAttributes.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLAttributes.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLAttributes.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLAttributes.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLAttributes.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLAttributes.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLAttributes.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLAttributes.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLAttributes.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLAttributes.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLAttributes.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLAttributes.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLAttributes.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLAttributes.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLAttributes.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLAttributes.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLAttributes.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLAttributes.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLAttributes.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLAttributes.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLAttributes.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLAttributes.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLAttributes.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLAttributes.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLAttributes.autoSave

+
+

big#

+

• Optional big: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLAttributes.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLAttributes.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLAttributes.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLAttributes.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLAttributes.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLAttributes.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLAttributes.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLAttributes.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLAttributes.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLAttributes.dir

+
+

disabled#

+

• Optional disabled: boolean

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLAttributes.draggable

+
+

focusable#

+

• Optional focusable: boolean

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLAttributes.hidden

+
+

href#

+

• Optional href: string

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLAttributes.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLAttributes.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLAttributes.inputMode

+
+

interactive#

+

• Optional interactive: boolean

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLAttributes.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLAttributes.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLAttributes.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLAttributes.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLAttributes.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLAttributes.itemType

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLAttributes.lang

+
+ +

• Optional link: LocationDescriptor<Object>

+
+

material#

+

• Optional material: string

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheelCapture

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLAttributes.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLAttributes.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLAttributes.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLAttributes.radioGroup

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLAttributes.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLAttributes.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLAttributes.role

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLAttributes.security

+
+

size#

+

• Optional size: string | number

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLAttributes.slot

+
+

small#

+

• Optional small: boolean

+
+

smallest#

+

• Optional smallest: boolean

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLAttributes.spellCheck

+
+

sticker#

+

• Optional sticker: boolean

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLAttributes.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressHydrationWarning

+
+

svg#

+

• Optional svg: string

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLAttributes.tabIndex

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLAttributes.title

+
+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+

Inherited from#

+

TooltipDecoratorProps.tooltip

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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

+

Inherited from#

+

TooltipDecoratorProps.tooltipOverrideDisabled

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLAttributes.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLAttributes.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLAttributes.unselectable

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLAttributes.vocab

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.inputvalidator/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.inputvalidator/index.html new file mode 100644 index 0000000000..a0612a8386 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.inputvalidator/index.html @@ -0,0 +1,930 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: InputValidator - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: InputValidator#

+

Renderer.Component.InputValidator

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

debounce#

+

• Optional debounce: number

+
+

message#

+

• Optional message: ReactNode | (value: string, props?: InputProps) => ReactNode

+

Methods#

+

condition#

+

▸ Optional condition(props): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsInputProps
+

Returns#

+

boolean

+
+

validate#

+

▸ validate(value, props?): boolean | Promise<any>

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
valuestring
props?InputProps
+

Returns#

+

boolean | Promise<any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html new file mode 100644 index 0000000000..940f1b7732 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/index.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeEventDetailsProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeEventDetailsProps#

+

Renderer.Component.KubeEventDetailsProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

object#

+

• object: KubeObject<KubeObjectMetadata, any, any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html new file mode 100644 index 0000000000..ec248449f0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailsProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeObjectDetailsProps<T>#

+

Renderer.Component.KubeObjectDetailsProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject = KubeObject
+

Table of contents#

+

Properties#

+ +

Properties#

+

className#

+

• Optional className: string

+
+

object#

+

• object: T

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html new file mode 100644 index 0000000000..4973457c2a --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/index.html @@ -0,0 +1,1381 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectListLayoutProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeObjectListLayoutProps<K>#

+

Renderer.Component.KubeObjectListLayoutProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
KK: KubeObject
+

Hierarchy#

+
    +
  • ItemListLayoutProps<K>
    • +
+

↳ KubeObjectListLayoutProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

addRemoveButtons#

+

• Optional addRemoveButtons: Partial<AddRemoveButtonsProps>

+

Inherited from#

+

ItemListLayoutProps.addRemoveButtons

+
+

className#

+

• className: IClassName

+

Inherited from#

+

ItemListLayoutProps.className

+
+

copyClassNameFromHeadCells#

+

• Optional copyClassNameFromHeadCells: boolean

+

Inherited from#

+

ItemListLayoutProps.copyClassNameFromHeadCells

+
+

customizeHeader#

+

• Optional customizeHeader: HeaderCustomizer | HeaderCustomizer[]

+

Inherited from#

+

ItemListLayoutProps.customizeHeader

+
+

customizeRemoveDialog#

+

• Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>

+

Type declaration#

+

▸ (selectedItems): Partial<ConfirmDialogParams>

+
Parameters#
+ + + + + + + + + + + + + +
NameType
selectedItemsK[]
+
Returns#
+

Partial<ConfirmDialogParams>

+

Inherited from#

+

ItemListLayoutProps.customizeRemoveDialog

+
+

customizeTableRowProps#

+

• Optional customizeTableRowProps: (item: K) => Partial<TableRowProps>

+

Type declaration#

+

▸ (item): Partial<TableRowProps>

+
Parameters#
+ + + + + + + + + + + + + +
NameType
itemK
+
Returns#
+

Partial<TableRowProps>

+

Inherited from#

+

ItemListLayoutProps.customizeTableRowProps

+
+

dependentStores#

+

• Optional dependentStores: KubeObjectStore<KubeObject<KubeObjectMetadata, any, any>>[]

+

Overrides#

+

ItemListLayoutProps.dependentStores

+
+

detailsItem#

+

• Optional detailsItem: K

+

Inherited from#

+

ItemListLayoutProps.detailsItem

+
+

filterCallbacks#

+

• Optional filterCallbacks: ItemsFilters<K>

+

Inherited from#

+

ItemListLayoutProps.filterCallbacks

+
+

filterItems#

+

• Optional filterItems: ItemsFilter<K>[]

+

deprecated

+

Inherited from#

+

ItemListLayoutProps.filterItems

+
+

hasDetailsView#

+

• Optional hasDetailsView: boolean

+

Inherited from#

+

ItemListLayoutProps.hasDetailsView

+
+

headerClassName#

+

• Optional headerClassName: IClassName

+

Inherited from#

+

ItemListLayoutProps.headerClassName

+
+

hideFilters#

+

• Optional hideFilters: boolean

+

Inherited from#

+

ItemListLayoutProps.hideFilters

+
+

isConfigurable#

+

• Optional isConfigurable: boolean

+

Inherited from#

+

ItemListLayoutProps.isConfigurable

+
+

isReady#

+

• Optional isReady: boolean

+

Inherited from#

+

ItemListLayoutProps.isReady

+
+

isSelectable#

+

• Optional isSelectable: boolean

+

Inherited from#

+

ItemListLayoutProps.isSelectable

+
+

items#

+

• Optional items: K[]

+

Inherited from#

+

ItemListLayoutProps.items

+
+

onDetails#

+

• Optional onDetails: (item: K) => void

+

Type declaration#

+

▸ (item): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
itemK
+
Returns#
+

void

+

Inherited from#

+

ItemListLayoutProps.onDetails

+
+

preloadStores#

+

• Optional preloadStores: boolean

+

Inherited from#

+

ItemListLayoutProps.preloadStores

+
+

renderFooter#

+

• Optional renderFooter: (parent: ItemListLayout) => ReactNode

+

Type declaration#

+

▸ (parent): ReactNode

+
Parameters#
+ + + + + + + + + + + + + +
NameType
parentItemListLayout<K>
+
Returns#
+

ReactNode

+

Inherited from#

+

ItemListLayoutProps.renderFooter

+
+

renderHeaderTitle#

+

• Optional renderHeaderTitle: ReactNode | (parent: ItemListLayout) => ReactNode

+

Inherited from#

+

ItemListLayoutProps.renderHeaderTitle

+
+

renderItemMenu#

+

• Optional renderItemMenu: (item: K, store: ItemStore) => ReactNode

+

Type declaration#

+

▸ (item, store): ReactNode

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
itemK
storeItemStore<K>
+
Returns#
+

ReactNode

+

Inherited from#

+

ItemListLayoutProps.renderItemMenu

+
+

renderTableContents#

+

• renderTableContents: (item: K) => (ReactNode | TableCellProps)[]

+

Type declaration#

+

▸ (item): (ReactNode | TableCellProps)[]

+
Parameters#
+ + + + + + + + + + + + + +
NameType
itemK
+
Returns#
+

(ReactNode | TableCellProps)[]

+

Inherited from#

+

ItemListLayoutProps.renderTableContents

+
+

renderTableHeader#

+

• renderTableHeader: TableCellProps[]

+

Inherited from#

+

ItemListLayoutProps.renderTableHeader

+
+

searchFilters#

+

• Optional searchFilters: SearchFilter<K>[]

+

Inherited from#

+

ItemListLayoutProps.searchFilters

+
+

showHeader#

+

• Optional showHeader: boolean

+

Inherited from#

+

ItemListLayoutProps.showHeader

+
+

sortingCallbacks#

+

• Optional sortingCallbacks: TableSortCallbacks<K>

+

Inherited from#

+

ItemListLayoutProps.sortingCallbacks

+
+

store#

+

• store: KubeObjectStore<K>

+

Overrides#

+

ItemListLayoutProps.store

+
+

tableId#

+

• Optional tableId: string

+

Inherited from#

+

ItemListLayoutProps.tableId

+
+

tableProps#

+

• Optional tableProps: Partial<TableProps<K>>

+

Inherited from#

+

ItemListLayoutProps.tableProps

+
+

virtual#

+

• Optional virtual: boolean

+

Inherited from#

+

ItemListLayoutProps.virtual

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html new file mode 100644 index 0000000000..07ee5d776b --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html @@ -0,0 +1,1196 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeObjectMenuProps<T>#

+

Renderer.Component.KubeObjectMenuProps

+

Type parameters#

+ + + + + + + + + + + +
Name
T
+

Hierarchy#

+ +

↳ KubeObjectMenuProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

autoCloseOnSelect#

+

• Optional autoCloseOnSelect: boolean

+

Inherited from#

+

MenuActionsProps.autoCloseOnSelect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

MenuActionsProps.autoFocus

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

MenuActionsProps.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

MenuActionsProps.className

+
+

closeOnClickItem#

+

• Optional closeOnClickItem: boolean

+

Inherited from#

+

MenuActionsProps.closeOnClickItem

+
+

closeOnClickOutside#

+

• Optional closeOnClickOutside: boolean

+

Inherited from#

+

MenuActionsProps.closeOnClickOutside

+
+

closeOnScroll#

+

• Optional closeOnScroll: boolean

+

Inherited from#

+

MenuActionsProps.closeOnScroll

+
+

editable#

+

• Optional editable: boolean

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

MenuActionsProps.htmlFor

+
+

id#

+

• Optional id: string

+

Inherited from#

+

MenuActionsProps.id

+
+

isOpen#

+

• Optional isOpen: boolean

+

Inherited from#

+

MenuActionsProps.isOpen

+
+

object#

+

• object: T

+
+

position#

+

• Optional position: MenuPosition

+

Inherited from#

+

MenuActionsProps.position

+
+

removable#

+

• Optional removable: boolean

+
+

removeConfirmationMessage#

+

• Optional removeConfirmationMessage: ReactNode | () => ReactNode

+

Inherited from#

+

MenuActionsProps.removeConfirmationMessage

+
+

toggleEvent#

+

• Optional toggleEvent: "click" | "contextmenu"

+

Inherited from#

+

MenuActionsProps.toggleEvent

+
+

toolbar#

+

• Optional toolbar: boolean

+

Inherited from#

+

MenuActionsProps.toolbar

+
+

triggerIcon#

+

• Optional triggerIcon: ReactNode | IconProps

+

Inherited from#

+

MenuActionsProps.triggerIcon

+
+

usePortal#

+

• Optional usePortal: boolean | HTMLElement

+

Inherited from#

+

MenuActionsProps.usePortal

+

Methods#

+

close#

+

▸ Optional close(): void

+

Returns#

+

void

+

Inherited from#

+

MenuActionsProps.close

+
+

onOpen#

+

▸ Optional onOpen(): void

+

Returns#

+

void

+

Inherited from#

+

MenuActionsProps.onOpen

+
+

open#

+

▸ Optional open(): void

+

Returns#

+

void

+

Inherited from#

+

MenuActionsProps.open

+
+

removeAction#

+

▸ Optional removeAction(): void

+

Returns#

+

void

+

Inherited from#

+

MenuActionsProps.removeAction

+
+

updateAction#

+

▸ Optional updateAction(): void

+

Returns#

+

void

+

Inherited from#

+

MenuActionsProps.updateAction

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html new file mode 100644 index 0000000000..aa7d2b088d --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/index.html @@ -0,0 +1,847 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMetaProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: KubeObjectMetaProps#

+

Renderer.Component.KubeObjectMetaProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

hideFields#

+

• Optional hideFields: keyof KubeObjectMetadata[]

+
+

object#

+

• object: KubeObject<KubeObjectMetadata, any, any>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.lineprogressprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.lineprogressprops/index.html new file mode 100644 index 0000000000..bee280d2ea --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.lineprogressprops/index.html @@ -0,0 +1,5671 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: LineProgressProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: LineProgressProps#

+

Renderer.Component.LineProgressProps

+

Hierarchy#

+ +

↳ LineProgressProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLProps.about

+
+

accept#

+

• Optional accept: string

+

Inherited from#

+

React.HTMLProps.accept

+
+

acceptCharset#

+

• Optional acceptCharset: string

+

Inherited from#

+

React.HTMLProps.acceptCharset

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLProps.accessKey

+
+

action#

+

• Optional action: string

+

Inherited from#

+

React.HTMLProps.action

+
+

allowFullScreen#

+

• Optional allowFullScreen: boolean

+

Inherited from#

+

React.HTMLProps.allowFullScreen

+
+

allowTransparency#

+

• Optional allowTransparency: boolean

+

Inherited from#

+

React.HTMLProps.allowTransparency

+
+

alt#

+

• Optional alt: string

+

Inherited from#

+

React.HTMLProps.alt

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLProps.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLProps.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLProps.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLProps.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLProps.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLProps.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLProps.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLProps.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLProps.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLProps.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLProps.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLProps.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLProps.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLProps.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLProps.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLProps.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLProps.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLProps.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLProps.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLProps.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLProps.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLProps.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLProps.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLProps.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuetext

+
+

as#

+

• Optional as: string

+

Inherited from#

+

React.HTMLProps.as

+
+

async#

+

• Optional async: boolean

+

Inherited from#

+

React.HTMLProps.async

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLProps.autoCapitalize

+
+

autoComplete#

+

• Optional autoComplete: string

+

Inherited from#

+

React.HTMLProps.autoComplete

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLProps.autoCorrect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

React.HTMLProps.autoFocus

+
+

autoPlay#

+

• Optional autoPlay: boolean

+

Inherited from#

+

React.HTMLProps.autoPlay

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLProps.autoSave

+
+

capture#

+

• Optional capture: string | boolean

+

Inherited from#

+

React.HTMLProps.capture

+
+

cellPadding#

+

• Optional cellPadding: string | number

+

Inherited from#

+

React.HTMLProps.cellPadding

+
+

cellSpacing#

+

• Optional cellSpacing: string | number

+

Inherited from#

+

React.HTMLProps.cellSpacing

+
+

challenge#

+

• Optional challenge: string

+

Inherited from#

+

React.HTMLProps.challenge

+
+

charSet#

+

• Optional charSet: string

+

Inherited from#

+

React.HTMLProps.charSet

+
+

checked#

+

• Optional checked: boolean

+

Inherited from#

+

React.HTMLProps.checked

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLProps.children

+
+

cite#

+

• Optional cite: string

+

Inherited from#

+

React.HTMLProps.cite

+
+

classID#

+

• Optional classID: string

+

Inherited from#

+

React.HTMLProps.classID

+
+

className#

+

• Optional className: any

+

Overrides#

+

React.HTMLProps.className

+
+

colSpan#

+

• Optional colSpan: number

+

Inherited from#

+

React.HTMLProps.colSpan

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLProps.color

+
+

cols#

+

• Optional cols: number

+

Inherited from#

+

React.HTMLProps.cols

+
+

content#

+

• Optional content: string

+

Inherited from#

+

React.HTMLProps.content

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLProps.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLProps.contextMenu

+
+

controls#

+

• Optional controls: boolean

+

Inherited from#

+

React.HTMLProps.controls

+
+

coords#

+

• Optional coords: string

+

Inherited from#

+

React.HTMLProps.coords

+
+

crossOrigin#

+

• Optional crossOrigin: string

+

Inherited from#

+

React.HTMLProps.crossOrigin

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLProps.dangerouslySetInnerHTML

+
+

data#

+

• Optional data: string

+

Inherited from#

+

React.HTMLProps.data

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLProps.datatype

+
+

dateTime#

+

• Optional dateTime: string

+

Inherited from#

+

React.HTMLProps.dateTime

+
+

default#

+

• Optional default: boolean

+

Inherited from#

+

React.HTMLProps.default

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLProps.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.defaultValue

+
+

defer#

+

• Optional defer: boolean

+

Inherited from#

+

React.HTMLProps.defer

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLProps.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Inherited from#

+

React.HTMLProps.disabled

+
+

download#

+

• Optional download: any

+

Inherited from#

+

React.HTMLProps.download

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLProps.draggable

+
+

encType#

+

• Optional encType: string

+

Inherited from#

+

React.HTMLProps.encType

+
+

form#

+

• Optional form: string

+

Inherited from#

+

React.HTMLProps.form

+
+

formAction#

+

• Optional formAction: string

+

Inherited from#

+

React.HTMLProps.formAction

+
+

formEncType#

+

• Optional formEncType: string

+

Inherited from#

+

React.HTMLProps.formEncType

+
+

formMethod#

+

• Optional formMethod: string

+

Inherited from#

+

React.HTMLProps.formMethod

+
+

formNoValidate#

+

• Optional formNoValidate: boolean

+

Inherited from#

+

React.HTMLProps.formNoValidate

+
+

formTarget#

+

• Optional formTarget: string

+

Inherited from#

+

React.HTMLProps.formTarget

+
+

frameBorder#

+

• Optional frameBorder: string | number

+

Inherited from#

+

React.HTMLProps.frameBorder

+
+

headers#

+

• Optional headers: string

+

Inherited from#

+

React.HTMLProps.headers

+
+

height#

+

• Optional height: string | number

+

Inherited from#

+

React.HTMLProps.height

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLProps.hidden

+
+

high#

+

• Optional high: number

+

Inherited from#

+

React.HTMLProps.high

+
+

href#

+

• Optional href: string

+

Inherited from#

+

React.HTMLProps.href

+
+

hrefLang#

+

• Optional hrefLang: string

+

Inherited from#

+

React.HTMLProps.hrefLang

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

React.HTMLProps.htmlFor

+
+

httpEquiv#

+

• Optional httpEquiv: string

+

Inherited from#

+

React.HTMLProps.httpEquiv

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLProps.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLProps.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLProps.inputMode

+
+

integrity#

+

• Optional integrity: string

+

Inherited from#

+

React.HTMLProps.integrity

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLProps.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLProps.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLProps.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLProps.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLProps.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLProps.itemType

+
+

key#

+

• Optional key: Key

+

Inherited from#

+

React.HTMLProps.key

+
+

keyParams#

+

• Optional keyParams: string

+

Inherited from#

+

React.HTMLProps.keyParams

+
+

keyType#

+

• Optional keyType: string

+

Inherited from#

+

React.HTMLProps.keyType

+
+

kind#

+

• Optional kind: string

+

Inherited from#

+

React.HTMLProps.kind

+
+

label#

+

• Optional label: string

+

Inherited from#

+

React.HTMLProps.label

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLProps.lang

+
+

list#

+

• Optional list: string

+

Inherited from#

+

React.HTMLProps.list

+
+

loop#

+

• Optional loop: boolean

+

Inherited from#

+

React.HTMLProps.loop

+
+

low#

+

• Optional low: number

+

Inherited from#

+

React.HTMLProps.low

+
+

manifest#

+

• Optional manifest: string

+

Inherited from#

+

React.HTMLProps.manifest

+
+

marginHeight#

+

• Optional marginHeight: number

+

Inherited from#

+

React.HTMLProps.marginHeight

+
+

marginWidth#

+

• Optional marginWidth: number

+

Inherited from#

+

React.HTMLProps.marginWidth

+
+

max#

+

• Optional max: number

+

Overrides#

+

React.HTMLProps.max

+
+

maxLength#

+

• Optional maxLength: number

+

Inherited from#

+

React.HTMLProps.maxLength

+
+

media#

+

• Optional media: string

+

Inherited from#

+

React.HTMLProps.media

+
+

mediaGroup#

+

• Optional mediaGroup: string

+

Inherited from#

+

React.HTMLProps.mediaGroup

+
+

method#

+

• Optional method: string

+

Inherited from#

+

React.HTMLProps.method

+
+

min#

+

• Optional min: number

+

Overrides#

+

React.HTMLProps.min

+
+

minLength#

+

• Optional minLength: number

+

Inherited from#

+

React.HTMLProps.minLength

+
+

multiple#

+

• Optional multiple: boolean

+

Inherited from#

+

React.HTMLProps.multiple

+
+

muted#

+

• Optional muted: boolean

+

Inherited from#

+

React.HTMLProps.muted

+
+

name#

+

• Optional name: string

+

Inherited from#

+

React.HTMLProps.name

+
+

noValidate#

+

• Optional noValidate: boolean

+

Inherited from#

+

React.HTMLProps.noValidate

+
+

nonce#

+

• Optional nonce: string

+

Inherited from#

+

React.HTMLProps.nonce

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheelCapture

+
+

open#

+

• Optional open: boolean

+

Inherited from#

+

React.HTMLProps.open

+
+

optimum#

+

• Optional optimum: number

+

Inherited from#

+

React.HTMLProps.optimum

+
+

pattern#

+

• Optional pattern: string

+

Inherited from#

+

React.HTMLProps.pattern

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLProps.placeholder

+
+

playsInline#

+

• Optional playsInline: boolean

+

Inherited from#

+

React.HTMLProps.playsInline

+
+

poster#

+

• Optional poster: string

+

Inherited from#

+

React.HTMLProps.poster

+
+

precise#

+

• Optional precise: number

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLProps.prefix

+
+

preload#

+

• Optional preload: string

+

Inherited from#

+

React.HTMLProps.preload

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLProps.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLProps.radioGroup

+
+

readOnly#

+

• Optional readOnly: boolean

+

Inherited from#

+

React.HTMLProps.readOnly

+
+

ref#

+

• Optional ref: LegacyRef<any>

+

Inherited from#

+

React.HTMLProps.ref

+
+

rel#

+

• Optional rel: string

+

Inherited from#

+

React.HTMLProps.rel

+
+

required#

+

• Optional required: boolean

+

Inherited from#

+

React.HTMLProps.required

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLProps.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLProps.results

+
+

reversed#

+

• Optional reversed: boolean

+

Inherited from#

+

React.HTMLProps.reversed

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLProps.role

+
+

rowSpan#

+

• Optional rowSpan: number

+

Inherited from#

+

React.HTMLProps.rowSpan

+
+

rows#

+

• Optional rows: number

+

Inherited from#

+

React.HTMLProps.rows

+
+

sandbox#

+

• Optional sandbox: string

+

Inherited from#

+

React.HTMLProps.sandbox

+
+

scope#

+

• Optional scope: string

+

Inherited from#

+

React.HTMLProps.scope

+
+

scoped#

+

• Optional scoped: boolean

+

Inherited from#

+

React.HTMLProps.scoped

+
+

scrolling#

+

• Optional scrolling: string

+

Inherited from#

+

React.HTMLProps.scrolling

+
+

seamless#

+

• Optional seamless: boolean

+

Inherited from#

+

React.HTMLProps.seamless

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLProps.security

+
+

selected#

+

• Optional selected: boolean

+

Inherited from#

+

React.HTMLProps.selected

+
+

shape#

+

• Optional shape: string

+

Inherited from#

+

React.HTMLProps.shape

+
+

size#

+

• Optional size: number

+

Inherited from#

+

React.HTMLProps.size

+
+

sizes#

+

• Optional sizes: string

+

Inherited from#

+

React.HTMLProps.sizes

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLProps.slot

+
+

span#

+

• Optional span: number

+

Inherited from#

+

React.HTMLProps.span

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLProps.spellCheck

+
+

src#

+

• Optional src: string

+

Inherited from#

+

React.HTMLProps.src

+
+

srcDoc#

+

• Optional srcDoc: string

+

Inherited from#

+

React.HTMLProps.srcDoc

+
+

srcLang#

+

• Optional srcLang: string

+

Inherited from#

+

React.HTMLProps.srcLang

+
+

srcSet#

+

• Optional srcSet: string

+

Inherited from#

+

React.HTMLProps.srcSet

+
+

start#

+

• Optional start: number

+

Inherited from#

+

React.HTMLProps.start

+
+

step#

+

• Optional step: string | number

+

Inherited from#

+

React.HTMLProps.step

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLProps.style

+
+

summary#

+

• Optional summary: string

+

Inherited from#

+

React.HTMLProps.summary

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLProps.tabIndex

+
+

target#

+

• Optional target: string

+

Inherited from#

+

React.HTMLProps.target

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLProps.title

+
+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+

Inherited from#

+

TooltipDecoratorProps.tooltip

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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

+

Inherited from#

+

TooltipDecoratorProps.tooltipOverrideDisabled

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLProps.translate

+
+

type#

+

• Optional type: string

+

Inherited from#

+

React.HTMLProps.type

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLProps.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLProps.unselectable

+
+

useMap#

+

• Optional useMap: string

+

Inherited from#

+

React.HTMLProps.useMap

+
+

value#

+

• value: number

+

Overrides#

+

React.HTMLProps.value

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLProps.vocab

+
+

width#

+

• Optional width: string | number

+

Inherited from#

+

React.HTMLProps.width

+
+

wmode#

+

• Optional wmode: string

+

Inherited from#

+

React.HTMLProps.wmode

+
+

wrap#

+

• Optional wrap: string

+

Inherited from#

+

React.HTMLProps.wrap

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.menuactionsprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.menuactionsprops/index.html new file mode 100644 index 0000000000..e71fe845b3 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.menuactionsprops/index.html @@ -0,0 +1,1130 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MenuActionsProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MenuActionsProps#

+

Renderer.Component.MenuActionsProps

+

Hierarchy#

+ +

↳ MenuActionsProps

+

↳↳ KubeObjectMenuProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

autoCloseOnSelect#

+

• Optional autoCloseOnSelect: boolean

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

Partial.autoFocus

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

Partial.children

+
+

className#

+

• Optional className: string

+

Overrides#

+

Partial.className

+
+

closeOnClickItem#

+

• Optional closeOnClickItem: boolean

+

Inherited from#

+

Partial.closeOnClickItem

+
+

closeOnClickOutside#

+

• Optional closeOnClickOutside: boolean

+

Inherited from#

+

Partial.closeOnClickOutside

+
+

closeOnScroll#

+

• Optional closeOnScroll: boolean

+

Inherited from#

+

Partial.closeOnScroll

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

Partial.htmlFor

+
+

id#

+

• Optional id: string

+

Inherited from#

+

Partial.id

+
+

isOpen#

+

• Optional isOpen: boolean

+

Inherited from#

+

Partial.isOpen

+
+

position#

+

• Optional position: MenuPosition

+

Inherited from#

+

Partial.position

+
+

removeConfirmationMessage#

+

• Optional removeConfirmationMessage: ReactNode | () => ReactNode

+
+

toggleEvent#

+

• Optional toggleEvent: "click" | "contextmenu"

+

Inherited from#

+

Partial.toggleEvent

+
+

toolbar#

+

• Optional toolbar: boolean

+
+

triggerIcon#

+

• Optional triggerIcon: ReactNode | IconProps

+
+

usePortal#

+

• Optional usePortal: boolean | HTMLElement

+

Inherited from#

+

Partial.usePortal

+

Methods#

+

close#

+

▸ Optional close(): void

+

Returns#

+

void

+

Inherited from#

+

Partial.close

+
+

onOpen#

+

▸ Optional onOpen(): void

+

Returns#

+

void

+
+

open#

+

▸ Optional open(): void

+

Returns#

+

void

+

Inherited from#

+

Partial.open

+
+

removeAction#

+

▸ Optional removeAction(): void

+

Returns#

+

void

+
+

updateAction#

+

▸ Optional updateAction(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.menuitemprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.menuitemprops/index.html new file mode 100644 index 0000000000..1b649af47a --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.menuitemprops/index.html @@ -0,0 +1,5660 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MenuItemProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MenuItemProps#

+

Renderer.Component.MenuItemProps

+

Hierarchy#

+
    +
  • HTMLProps<any>
    • +
+

↳ MenuItemProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLProps.about

+
+

accept#

+

• Optional accept: string

+

Inherited from#

+

React.HTMLProps.accept

+
+

acceptCharset#

+

• Optional acceptCharset: string

+

Inherited from#

+

React.HTMLProps.acceptCharset

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLProps.accessKey

+
+

action#

+

• Optional action: string

+

Inherited from#

+

React.HTMLProps.action

+
+

active#

+

• Optional active: boolean

+
+

allowFullScreen#

+

• Optional allowFullScreen: boolean

+

Inherited from#

+

React.HTMLProps.allowFullScreen

+
+

allowTransparency#

+

• Optional allowTransparency: boolean

+

Inherited from#

+

React.HTMLProps.allowTransparency

+
+

alt#

+

• Optional alt: string

+

Inherited from#

+

React.HTMLProps.alt

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLProps.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLProps.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLProps.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLProps.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLProps.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLProps.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLProps.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLProps.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLProps.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLProps.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLProps.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLProps.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLProps.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLProps.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLProps.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLProps.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLProps.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLProps.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLProps.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLProps.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLProps.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLProps.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLProps.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLProps.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuetext

+
+

as#

+

• Optional as: string

+

Inherited from#

+

React.HTMLProps.as

+
+

async#

+

• Optional async: boolean

+

Inherited from#

+

React.HTMLProps.async

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLProps.autoCapitalize

+
+

autoComplete#

+

• Optional autoComplete: string

+

Inherited from#

+

React.HTMLProps.autoComplete

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLProps.autoCorrect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

React.HTMLProps.autoFocus

+
+

autoPlay#

+

• Optional autoPlay: boolean

+

Inherited from#

+

React.HTMLProps.autoPlay

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLProps.autoSave

+
+

capture#

+

• Optional capture: string | boolean

+

Inherited from#

+

React.HTMLProps.capture

+
+

cellPadding#

+

• Optional cellPadding: string | number

+

Inherited from#

+

React.HTMLProps.cellPadding

+
+

cellSpacing#

+

• Optional cellSpacing: string | number

+

Inherited from#

+

React.HTMLProps.cellSpacing

+
+

challenge#

+

• Optional challenge: string

+

Inherited from#

+

React.HTMLProps.challenge

+
+

charSet#

+

• Optional charSet: string

+

Inherited from#

+

React.HTMLProps.charSet

+
+

checked#

+

• Optional checked: boolean

+

Inherited from#

+

React.HTMLProps.checked

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLProps.children

+
+

cite#

+

• Optional cite: string

+

Inherited from#

+

React.HTMLProps.cite

+
+

classID#

+

• Optional classID: string

+

Inherited from#

+

React.HTMLProps.classID

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLProps.className

+
+

colSpan#

+

• Optional colSpan: number

+

Inherited from#

+

React.HTMLProps.colSpan

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLProps.color

+
+

cols#

+

• Optional cols: number

+

Inherited from#

+

React.HTMLProps.cols

+
+

content#

+

• Optional content: string

+

Inherited from#

+

React.HTMLProps.content

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLProps.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLProps.contextMenu

+
+

controls#

+

• Optional controls: boolean

+

Inherited from#

+

React.HTMLProps.controls

+
+

coords#

+

• Optional coords: string

+

Inherited from#

+

React.HTMLProps.coords

+
+

crossOrigin#

+

• Optional crossOrigin: string

+

Inherited from#

+

React.HTMLProps.crossOrigin

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLProps.dangerouslySetInnerHTML

+
+

data#

+

• Optional data: string

+

Inherited from#

+

React.HTMLProps.data

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLProps.datatype

+
+

dateTime#

+

• Optional dateTime: string

+

Inherited from#

+

React.HTMLProps.dateTime

+
+

default#

+

• Optional default: boolean

+

Inherited from#

+

React.HTMLProps.default

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLProps.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.defaultValue

+
+

defer#

+

• Optional defer: boolean

+

Inherited from#

+

React.HTMLProps.defer

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLProps.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Overrides#

+

React.HTMLProps.disabled

+
+

download#

+

• Optional download: any

+

Inherited from#

+

React.HTMLProps.download

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLProps.draggable

+
+

encType#

+

• Optional encType: string

+

Inherited from#

+

React.HTMLProps.encType

+
+

form#

+

• Optional form: string

+

Inherited from#

+

React.HTMLProps.form

+
+

formAction#

+

• Optional formAction: string

+

Inherited from#

+

React.HTMLProps.formAction

+
+

formEncType#

+

• Optional formEncType: string

+

Inherited from#

+

React.HTMLProps.formEncType

+
+

formMethod#

+

• Optional formMethod: string

+

Inherited from#

+

React.HTMLProps.formMethod

+
+

formNoValidate#

+

• Optional formNoValidate: boolean

+

Inherited from#

+

React.HTMLProps.formNoValidate

+
+

formTarget#

+

• Optional formTarget: string

+

Inherited from#

+

React.HTMLProps.formTarget

+
+

frameBorder#

+

• Optional frameBorder: string | number

+

Inherited from#

+

React.HTMLProps.frameBorder

+
+

headers#

+

• Optional headers: string

+

Inherited from#

+

React.HTMLProps.headers

+
+

height#

+

• Optional height: string | number

+

Inherited from#

+

React.HTMLProps.height

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLProps.hidden

+
+

high#

+

• Optional high: number

+

Inherited from#

+

React.HTMLProps.high

+
+

href#

+

• Optional href: string

+

Overrides#

+

React.HTMLProps.href

+
+

hrefLang#

+

• Optional hrefLang: string

+

Inherited from#

+

React.HTMLProps.hrefLang

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

React.HTMLProps.htmlFor

+
+

httpEquiv#

+

• Optional httpEquiv: string

+

Inherited from#

+

React.HTMLProps.httpEquiv

+
+

icon#

+

• Optional icon: string | Partial<IconProps>

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLProps.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLProps.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLProps.inputMode

+
+

integrity#

+

• Optional integrity: string

+

Inherited from#

+

React.HTMLProps.integrity

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLProps.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLProps.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLProps.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLProps.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLProps.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLProps.itemType

+
+

key#

+

• Optional key: Key

+

Inherited from#

+

React.HTMLProps.key

+
+

keyParams#

+

• Optional keyParams: string

+

Inherited from#

+

React.HTMLProps.keyParams

+
+

keyType#

+

• Optional keyType: string

+

Inherited from#

+

React.HTMLProps.keyType

+
+

kind#

+

• Optional kind: string

+

Inherited from#

+

React.HTMLProps.kind

+
+

label#

+

• Optional label: string

+

Inherited from#

+

React.HTMLProps.label

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLProps.lang

+
+

list#

+

• Optional list: string

+

Inherited from#

+

React.HTMLProps.list

+
+

loop#

+

• Optional loop: boolean

+

Inherited from#

+

React.HTMLProps.loop

+
+

low#

+

• Optional low: number

+

Inherited from#

+

React.HTMLProps.low

+
+

manifest#

+

• Optional manifest: string

+

Inherited from#

+

React.HTMLProps.manifest

+
+

marginHeight#

+

• Optional marginHeight: number

+

Inherited from#

+

React.HTMLProps.marginHeight

+
+

marginWidth#

+

• Optional marginWidth: number

+

Inherited from#

+

React.HTMLProps.marginWidth

+
+

max#

+

• Optional max: string | number

+

Inherited from#

+

React.HTMLProps.max

+
+

maxLength#

+

• Optional maxLength: number

+

Inherited from#

+

React.HTMLProps.maxLength

+
+

media#

+

• Optional media: string

+

Inherited from#

+

React.HTMLProps.media

+
+

mediaGroup#

+

• Optional mediaGroup: string

+

Inherited from#

+

React.HTMLProps.mediaGroup

+
+

method#

+

• Optional method: string

+

Inherited from#

+

React.HTMLProps.method

+
+

min#

+

• Optional min: string | number

+

Inherited from#

+

React.HTMLProps.min

+
+

minLength#

+

• Optional minLength: number

+

Inherited from#

+

React.HTMLProps.minLength

+
+

multiple#

+

• Optional multiple: boolean

+

Inherited from#

+

React.HTMLProps.multiple

+
+

muted#

+

• Optional muted: boolean

+

Inherited from#

+

React.HTMLProps.muted

+
+

name#

+

• Optional name: string

+

Inherited from#

+

React.HTMLProps.name

+
+

noValidate#

+

• Optional noValidate: boolean

+

Inherited from#

+

React.HTMLProps.noValidate

+
+

nonce#

+

• Optional nonce: string

+

Inherited from#

+

React.HTMLProps.nonce

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheelCapture

+
+

open#

+

• Optional open: boolean

+

Inherited from#

+

React.HTMLProps.open

+
+

optimum#

+

• Optional optimum: number

+

Inherited from#

+

React.HTMLProps.optimum

+
+

pattern#

+

• Optional pattern: string

+

Inherited from#

+

React.HTMLProps.pattern

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLProps.placeholder

+
+

playsInline#

+

• Optional playsInline: boolean

+

Inherited from#

+

React.HTMLProps.playsInline

+
+

poster#

+

• Optional poster: string

+

Inherited from#

+

React.HTMLProps.poster

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLProps.prefix

+
+

preload#

+

• Optional preload: string

+

Inherited from#

+

React.HTMLProps.preload

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLProps.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLProps.radioGroup

+
+

readOnly#

+

• Optional readOnly: boolean

+

Inherited from#

+

React.HTMLProps.readOnly

+
+

ref#

+

• Optional ref: LegacyRef<any>

+

Inherited from#

+

React.HTMLProps.ref

+
+

rel#

+

• Optional rel: string

+

Inherited from#

+

React.HTMLProps.rel

+
+

required#

+

• Optional required: boolean

+

Inherited from#

+

React.HTMLProps.required

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLProps.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLProps.results

+
+

reversed#

+

• Optional reversed: boolean

+

Inherited from#

+

React.HTMLProps.reversed

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLProps.role

+
+

rowSpan#

+

• Optional rowSpan: number

+

Inherited from#

+

React.HTMLProps.rowSpan

+
+

rows#

+

• Optional rows: number

+

Inherited from#

+

React.HTMLProps.rows

+
+

sandbox#

+

• Optional sandbox: string

+

Inherited from#

+

React.HTMLProps.sandbox

+
+

scope#

+

• Optional scope: string

+

Inherited from#

+

React.HTMLProps.scope

+
+

scoped#

+

• Optional scoped: boolean

+

Inherited from#

+

React.HTMLProps.scoped

+
+

scrolling#

+

• Optional scrolling: string

+

Inherited from#

+

React.HTMLProps.scrolling

+
+

seamless#

+

• Optional seamless: boolean

+

Inherited from#

+

React.HTMLProps.seamless

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLProps.security

+
+

selected#

+

• Optional selected: boolean

+

Inherited from#

+

React.HTMLProps.selected

+
+

shape#

+

• Optional shape: string

+

Inherited from#

+

React.HTMLProps.shape

+
+

size#

+

• Optional size: number

+

Inherited from#

+

React.HTMLProps.size

+
+

sizes#

+

• Optional sizes: string

+

Inherited from#

+

React.HTMLProps.sizes

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLProps.slot

+
+

spacer#

+

• Optional spacer: boolean

+
+

span#

+

• Optional span: number

+

Inherited from#

+

React.HTMLProps.span

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLProps.spellCheck

+
+

src#

+

• Optional src: string

+

Inherited from#

+

React.HTMLProps.src

+
+

srcDoc#

+

• Optional srcDoc: string

+

Inherited from#

+

React.HTMLProps.srcDoc

+
+

srcLang#

+

• Optional srcLang: string

+

Inherited from#

+

React.HTMLProps.srcLang

+
+

srcSet#

+

• Optional srcSet: string

+

Inherited from#

+

React.HTMLProps.srcSet

+
+

start#

+

• Optional start: number

+

Inherited from#

+

React.HTMLProps.start

+
+

step#

+

• Optional step: string | number

+

Inherited from#

+

React.HTMLProps.step

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLProps.style

+
+

summary#

+

• Optional summary: string

+

Inherited from#

+

React.HTMLProps.summary

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLProps.tabIndex

+
+

target#

+

• Optional target: string

+

Inherited from#

+

React.HTMLProps.target

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLProps.title

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLProps.translate

+
+

type#

+

• Optional type: string

+

Inherited from#

+

React.HTMLProps.type

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLProps.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLProps.unselectable

+
+

useMap#

+

• Optional useMap: string

+

Inherited from#

+

React.HTMLProps.useMap

+
+

value#

+

• Optional value: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.value

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLProps.vocab

+
+

width#

+

• Optional width: string | number

+

Inherited from#

+

React.HTMLProps.width

+
+

wmode#

+

• Optional wmode: string

+

Inherited from#

+

React.HTMLProps.wmode

+
+

wrap#

+

• Optional wrap: string

+

Inherited from#

+

React.HTMLProps.wrap

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.menuposition/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.menuposition/index.html new file mode 100644 index 0000000000..7c490e9661 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.menuposition/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MenuPosition - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MenuPosition#

+

Renderer.Component.MenuPosition

+

Table of contents#

+

Properties#

+ +

Properties#

+

bottom#

+

• Optional bottom: boolean

+
+

left#

+

• Optional left: boolean

+
+ +

• Optional right: boolean

+
+

top#

+

• Optional top: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.menuprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.menuprops/index.html new file mode 100644 index 0000000000..578605c9b7 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.menuprops/index.html @@ -0,0 +1,1006 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MenuProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MenuProps#

+

Renderer.Component.MenuProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

autoFocus#

+

• Optional autoFocus: boolean

+
+

children#

+

• Optional children: ReactNode

+
+

className#

+

• Optional className: string

+
+

closeOnClickItem#

+

• Optional closeOnClickItem: boolean

+
+

closeOnClickOutside#

+

• Optional closeOnClickOutside: boolean

+
+

closeOnScroll#

+

• Optional closeOnScroll: boolean

+
+

htmlFor#

+

• Optional htmlFor: string

+
+

id#

+

• Optional id: string

+
+

isOpen#

+

• Optional isOpen: boolean

+
+

position#

+

• Optional position: MenuPosition

+
+

toggleEvent#

+

• Optional toggleEvent: "click" | "contextmenu"

+
+

usePortal#

+

• Optional usePortal: boolean | HTMLElement

+

Methods#

+

close#

+

▸ close(): void

+

Returns#

+

void

+
+

open#

+

▸ open(): void

+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.notification/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.notification/index.html new file mode 100644 index 0000000000..5c5747c26c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.notification/index.html @@ -0,0 +1,905 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: Notification - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.radiogroupprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.radiogroupprops/index.html new file mode 100644 index 0000000000..3b6220f905 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.radiogroupprops/index.html @@ -0,0 +1,920 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: RadioGroupProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: RadioGroupProps#

+

Renderer.Component.RadioGroupProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

asButtons#

+

• Optional asButtons: boolean

+
+

className#

+

• Optional className: any

+
+

disabled#

+

• Optional disabled: boolean

+
+

value#

+

• Optional value: any

+

Methods#

+

onChange#

+

▸ Optional onChange(value): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valuestring
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.selectoption/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.selectoption/index.html new file mode 100644 index 0000000000..06fbac1992 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.selectoption/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SelectOption - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: SelectOption<T>#

+

Renderer.Component.SelectOption

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT = any
+

Table of contents#

+

Properties#

+ +

Properties#

+

label#

+

• Optional label: ReactNode

+
+

value#

+

• value: T

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.selectprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.selectprops/index.html new file mode 100644 index 0000000000..c9acf4d6a9 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.selectprops/index.html @@ -0,0 +1,2206 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SelectProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: SelectProps<T>#

+

Renderer.Component.SelectProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT = any
+

Hierarchy#

+
    +
  • +

    ReactSelectProps<T, boolean>

    +
    • +
  • +

    CreatableProps<T, boolean>

    +
    • +
+

↳ SelectProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

allowCreateWhileLoading#

+

• Optional allowCreateWhileLoading: boolean

+

Inherited from#

+

CreatableProps.allowCreateWhileLoading

+
+

aria-label#

+

• Optional aria-label: string

+

Inherited from#

+

ReactSelectProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Inherited from#

+

ReactSelectProps.aria-labelledby

+
+

autoConvertOptions#

+

• Optional autoConvertOptions: boolean

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

ReactSelectProps.autoFocus

+
+

backspaceRemovesValue#

+

• Optional backspaceRemovesValue: boolean

+

Inherited from#

+

ReactSelectProps.backspaceRemovesValue

+
+

blurInputOnSelect#

+

• Optional blurInputOnSelect: boolean

+

Inherited from#

+

ReactSelectProps.blurInputOnSelect

+
+

captureMenuScroll#

+

• Optional captureMenuScroll: boolean

+

Inherited from#

+

ReactSelectProps.captureMenuScroll

+
+

className#

+

• Optional className: string

+

Inherited from#

+

ReactSelectProps.className

+
+

classNamePrefix#

+

• Optional classNamePrefix: string

+

Inherited from#

+

ReactSelectProps.classNamePrefix

+
+

closeMenuOnScroll#

+

• Optional closeMenuOnScroll: boolean | EventListener

+

Inherited from#

+

ReactSelectProps.closeMenuOnScroll

+
+

closeMenuOnSelect#

+

• Optional closeMenuOnSelect: boolean

+

Inherited from#

+

ReactSelectProps.closeMenuOnSelect

+
+

components#

+

• Optional components: Partial<SelectComponents<T, boolean>>

+

Inherited from#

+

ReactSelectProps.components

+
+

controlShouldRenderValue#

+

• Optional controlShouldRenderValue: boolean

+

Inherited from#

+

ReactSelectProps.controlShouldRenderValue

+
+

createOptionPosition#

+

• Optional createOptionPosition: "first" | "last"

+

Inherited from#

+

CreatableProps.createOptionPosition

+
+

defaultInputValue#

+

• Optional defaultInputValue: string

+

Inherited from#

+

ReactSelectProps.defaultInputValue

+
+

defaultMenuIsOpen#

+

• Optional defaultMenuIsOpen: boolean

+

Inherited from#

+

ReactSelectProps.defaultMenuIsOpen

+
+

defaultValue#

+

• Optional defaultValue: T | OptionsType<T>

+

Inherited from#

+

ReactSelectProps.defaultValue

+
+

delimiter#

+

• Optional delimiter: string

+

Inherited from#

+

ReactSelectProps.delimiter

+
+

escapeClearsValue#

+

• Optional escapeClearsValue: boolean

+

Inherited from#

+

ReactSelectProps.escapeClearsValue

+
+

filterOption#

+

• Optional filterOption: (option: Option, rawInput: string) => boolean

+

Type declaration#

+

▸ (option, rawInput): boolean

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
optionOption
rawInputstring
+
Returns#
+

boolean

+

Inherited from#

+

ReactSelectProps.filterOption

+
+

formatCreateLabel#

+

• Optional formatCreateLabel: (inputValue: string) => ReactNode

+

Type declaration#

+

▸ (inputValue): ReactNode

+
Parameters#
+ + + + + + + + + + + + + +
NameType
inputValuestring
+
Returns#
+

ReactNode

+

Inherited from#

+

CreatableProps.formatCreateLabel

+
+

formatGroupLabel#

+

• Optional formatGroupLabel: formatGroupLabel<T>

+

Inherited from#

+

ReactSelectProps.formatGroupLabel

+
+

formatOptionLabel#

+

• Optional formatOptionLabel: (option: T, labelMeta: FormatOptionLabelMeta) => ReactNode

+

Type declaration#

+

▸ (option, labelMeta): ReactNode

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
optionT
labelMetaFormatOptionLabelMeta<T, boolean>
+
Returns#
+

ReactNode

+

Inherited from#

+

ReactSelectProps.formatOptionLabel

+
+

getNewOptionData#

+

• Optional getNewOptionData: (inputValue: string, optionLabel: ReactNode) => T

+

Type declaration#

+

▸ (inputValue, optionLabel): T

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
inputValuestring
optionLabelReactNode
+
Returns#
+

T

+

Inherited from#

+

CreatableProps.getNewOptionData

+
+

getOptionLabel#

+

• Optional getOptionLabel: getOptionLabel<T>

+

Inherited from#

+

ReactSelectProps.getOptionLabel

+
+

getOptionValue#

+

• Optional getOptionValue: getOptionValue<T>

+

Inherited from#

+

ReactSelectProps.getOptionValue

+
+

hideSelectedOptions#

+

• Optional hideSelectedOptions: boolean

+

Inherited from#

+

ReactSelectProps.hideSelectedOptions

+
+

id#

+

• Optional id: string

+

Inherited from#

+

ReactSelectProps.id

+
+

inputId#

+

• Optional inputId: string

+

Inherited from#

+

ReactSelectProps.inputId

+
+

inputValue#

+

• Optional inputValue: string

+

Inherited from#

+

ReactSelectProps.inputValue

+
+

instanceId#

+

• Optional instanceId: string | number

+

Inherited from#

+

ReactSelectProps.instanceId

+
+

isClearable#

+

• Optional isClearable: boolean

+

Inherited from#

+

ReactSelectProps.isClearable

+
+

isCreatable#

+

• Optional isCreatable: boolean

+
+

isDisabled#

+

• Optional isDisabled: boolean

+

Inherited from#

+

ReactSelectProps.isDisabled

+
+

isLoading#

+

• Optional isLoading: boolean

+

Inherited from#

+

ReactSelectProps.isLoading

+
+

isMulti#

+

• Optional isMulti: boolean

+

Inherited from#

+

ReactSelectProps.isMulti

+
+

isOptionDisabled#

+

• Optional isOptionDisabled: (option: T, options: OptionsType) => boolean

+

Type declaration#

+

▸ (option, options): boolean

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
optionT
optionsOptionsType<T>
+
Returns#
+

boolean

+

Inherited from#

+

ReactSelectProps.isOptionDisabled

+
+

isOptionSelected#

+

• Optional isOptionSelected: (option: T, options: OptionsType) => boolean

+

Type declaration#

+

▸ (option, options): boolean

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
optionT
optionsOptionsType<T>
+
Returns#
+

boolean

+

Inherited from#

+

ReactSelectProps.isOptionSelected

+
+

isRtl#

+

• Optional isRtl: boolean

+

Inherited from#

+

ReactSelectProps.isRtl

+
+

isSearchable#

+

• Optional isSearchable: boolean

+

Inherited from#

+

ReactSelectProps.isSearchable

+
+

isValidNewOption#

+

• Optional isValidNewOption: (inputValue: string, value: T | OptionsType<T>, options: OptionsType<T> | GroupedOptionsType) => boolean

+

Type declaration#

+

▸ (inputValue, value, options): boolean

+
Parameters#
+ + + + + + + + + + + + + + + + + + + + + +
NameType
inputValuestring
valueT | OptionsType<T>
optionsOptionsType<T> | GroupedOptionsType<T>
+
Returns#
+

boolean

+

Inherited from#

+

CreatableProps.isValidNewOption

+
+

loadingMessage#

+

• Optional loadingMessage: (obj: { inputValue: string }) => string

+

Type declaration#

+

▸ (obj): string

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
objObject
obj.inputValuestring
+
Returns#
+

string

+

Inherited from#

+

ReactSelectProps.loadingMessage

+
+

maxMenuHeight#

+

• Optional maxMenuHeight: number

+

Inherited from#

+

ReactSelectProps.maxMenuHeight

+
+ +

• Optional menuClass: string

+
+ +

• Optional menuIsOpen: boolean

+

Inherited from#

+

ReactSelectProps.menuIsOpen

+
+ +

• Optional menuPlacement: MenuPlacement

+

Inherited from#

+

ReactSelectProps.menuPlacement

+
+ +

• Optional menuPortalTarget: HTMLElement

+

Inherited from#

+

ReactSelectProps.menuPortalTarget

+
+ +

• Optional menuPosition: MenuPosition

+

Inherited from#

+

ReactSelectProps.menuPosition

+
+ +

• Optional menuShouldBlockScroll: boolean

+

Inherited from#

+

ReactSelectProps.menuShouldBlockScroll

+
+ +

• Optional menuShouldScrollIntoView: boolean

+

Inherited from#

+

ReactSelectProps.menuShouldScrollIntoView

+
+

minMenuHeight#

+

• Optional minMenuHeight: number

+

Inherited from#

+

ReactSelectProps.minMenuHeight

+
+

name#

+

• Optional name: string

+

Inherited from#

+

ReactSelectProps.name

+
+

noOptionsMessage#

+

• Optional noOptionsMessage: (obj: { inputValue: string }) => string

+

Type declaration#

+

▸ (obj): string

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
objObject
obj.inputValuestring
+
Returns#
+

string

+

Inherited from#

+

ReactSelectProps.noOptionsMessage

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler

+

Inherited from#

+

ReactSelectProps.onBlur

+
+

onCreateOption#

+

• Optional onCreateOption: (inputValue: string) => void

+

Type declaration#

+

▸ (inputValue): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
inputValuestring
+
Returns#
+

void

+

Inherited from#

+

CreatableProps.onCreateOption

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler

+

Inherited from#

+

ReactSelectProps.onFocus

+
+

onInputChange#

+

• Optional onInputChange: (newValue: string, actionMeta: InputActionMeta) => void

+

Type declaration#

+

▸ (newValue, actionMeta): void

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
newValuestring
actionMetaInputActionMeta
+
Returns#
+

void

+

Inherited from#

+

ReactSelectProps.onInputChange

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler

+

Inherited from#

+

ReactSelectProps.onKeyDown

+
+

onMenuClose#

+

• Optional onMenuClose: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

ReactSelectProps.onMenuClose

+
+

onMenuOpen#

+

• Optional onMenuOpen: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

ReactSelectProps.onMenuOpen

+
+

onMenuScrollToBottom#

+

• Optional onMenuScrollToBottom: (event: SyntheticEvent) => void

+

Type declaration#

+

▸ (event): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
eventSyntheticEvent<HTMLElement, Event>
+
Returns#
+

void

+

Inherited from#

+

ReactSelectProps.onMenuScrollToBottom

+
+

onMenuScrollToTop#

+

• Optional onMenuScrollToTop: (event: SyntheticEvent) => void

+

Type declaration#

+

▸ (event): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
eventSyntheticEvent<HTMLElement, Event>
+
Returns#
+

void

+

Inherited from#

+

ReactSelectProps.onMenuScrollToTop

+
+

openMenuOnClick#

+

• Optional openMenuOnClick: boolean

+

Inherited from#

+

ReactSelectProps.openMenuOnClick

+
+

openMenuOnFocus#

+

• Optional openMenuOnFocus: boolean

+

Inherited from#

+

ReactSelectProps.openMenuOnFocus

+
+

options#

+

• Optional options: OptionsType<T> | GroupedOptionsType<T>

+

Inherited from#

+

ReactSelectProps.options

+
+

pageSize#

+

• Optional pageSize: number

+

Inherited from#

+

ReactSelectProps.pageSize

+
+

placeholder#

+

• Optional placeholder: ReactNode

+

Inherited from#

+

ReactSelectProps.placeholder

+
+

screenReaderStatus#

+

• Optional screenReaderStatus: (obj: { count: number }) => string

+

Type declaration#

+

▸ (obj): string

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
objObject
obj.countnumber
+
Returns#
+

string

+

Inherited from#

+

ReactSelectProps.screenReaderStatus

+
+

styles#

+

• Optional styles: Partial<Styles<T, boolean>>

+

Inherited from#

+

ReactSelectProps.styles

+
+

tabIndex#

+

• Optional tabIndex: string

+

Inherited from#

+

ReactSelectProps.tabIndex

+
+

tabSelectsValue#

+

• Optional tabSelectsValue: boolean

+

Inherited from#

+

ReactSelectProps.tabSelectsValue

+
+

theme#

+

• Optional theme: ThemeConfig

+

Inherited from#

+

ReactSelectProps.theme

+
+

themeName#

+

• Optional themeName: "lens" | "light" | "outlined" | "dark"

+
+

value#

+

• Optional value: T

+

Overrides#

+

ReactSelectProps.value

+

Methods#

+

onChange#

+

▸ Optional onChange(option, meta?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
optionT
meta?ActionMeta<any>
+

Returns#

+

void

+

Overrides#

+

ReactSelectProps.onChange

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html new file mode 100644 index 0000000000..cfd5fd7468 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.settinglayoutprops/index.html @@ -0,0 +1,3043 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SettingLayoutProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: SettingLayoutProps#

+

Renderer.Component.SettingLayoutProps

+

Hierarchy#

+
    +
  • DOMAttributes<any>
    • +
+

↳ SettingLayoutProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

back#

+

• Optional back: (evt: MouseEvent \| KeyboardEvent) => void

+

Type declaration#

+

▸ (evt): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
evtMouseEvent<Element, MouseEvent> | KeyboardEvent
+
Returns#
+

void

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: IClassName

+
+

contentClass#

+

• Optional contentClass: IClassName

+
+

contentGaps#

+

• Optional contentGaps: boolean

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+ +

• Optional navigation: ReactNode

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+
+

provideBackButtonNavigation#

+

• Optional provideBackButtonNavigation: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.sliderprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.sliderprops/index.html new file mode 100644 index 0000000000..570b2618dc --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.sliderprops/index.html @@ -0,0 +1,4631 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SliderProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: SliderProps#

+

Renderer.Component.SliderProps

+

Hierarchy#

+
    +
  • Omit<MaterialSliderProps, "onChange">
    • +
+

↳ SliderProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

ThumbComponent#

+

• Optional ThumbComponent: ElementType<HTMLAttributes<HTMLSpanElement>>

+

Inherited from#

+

Omit.ThumbComponent

+
+

ValueLabelComponent#

+

• Optional ValueLabelComponent: ElementType<ValueLabelProps>

+

Inherited from#

+

Omit.ValueLabelComponent

+
+

about#

+

• Optional about: string

+

Inherited from#

+

Omit.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

Omit.accessKey

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

Omit.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

Omit.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

Omit.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

Omit.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

Omit.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

Omit.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

Omit.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

Omit.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

Omit.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

Omit.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

Omit.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

Omit.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

Omit.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

Omit.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

Omit.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

Omit.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

Omit.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

Omit.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

Omit.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

Omit.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

Omit.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

Omit.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Inherited from#

+

Omit.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Inherited from#

+

Omit.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

Omit.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

Omit.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

Omit.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

Omit.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

Omit.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

Omit.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

Omit.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

Omit.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

Omit.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

Omit.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

Omit.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

Omit.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

Omit.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

Omit.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

Omit.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

Omit.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

Omit.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

Omit.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

Omit.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

Omit.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

Omit.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

Omit.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

Omit.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Inherited from#

+

Omit.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

Omit.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

Omit.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

Omit.autoSave

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

Omit.children

+
+

className#

+

• Optional className: string

+

Overrides#

+

Omit.className

+
+

classes#

+

• Optional classes: Partial<ClassNameMap<SliderClassKey>>

+

Override or extend the styles applied to the component.

+

Inherited from#

+

Omit.classes

+
+

color#

+

• Optional color: "primary" | "secondary"

+

Inherited from#

+

Omit.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

Omit.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

Omit.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

Omit.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

Omit.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

Omit.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: number & number & readonly string[] & number[] & string & number[] & number & number[] & readonly string[]

+

Inherited from#

+

Omit.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

Omit.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Inherited from#

+

Omit.disabled

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

Omit.draggable

+
+

getAriaLabel#

+

• Optional getAriaLabel: (index: number) => string

+

Type declaration#

+

▸ (index): string

+
Parameters#
+ + + + + + + + + + + + + +
NameType
indexnumber
+
Returns#
+

string

+

Inherited from#

+

Omit.getAriaLabel

+
+

getAriaValueText#

+

• Optional getAriaValueText: (value: number, index: number) => string

+

Type declaration#

+

▸ (value, index): string

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
valuenumber
indexnumber
+
Returns#
+

string

+

Inherited from#

+

Omit.getAriaValueText

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

Omit.hidden

+
+

id#

+

• Optional id: string

+

Inherited from#

+

Omit.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

Omit.inlist

+
+

innerRef#

+

• Optional innerRef: Ref<any>

+

Inherited from#

+

Omit.innerRef

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

Omit.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

Omit.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

Omit.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

Omit.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

Omit.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

Omit.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

Omit.itemType

+
+

key#

+

• Optional key: Key

+

Inherited from#

+

Omit.key

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

Omit.lang

+
+

marks#

+

• Optional marks: boolean | Mark[]

+

Inherited from#

+

Omit.marks

+
+

max#

+

• Optional max: number

+

Inherited from#

+

Omit.max

+
+

min#

+

• Optional min: number

+

Inherited from#

+

Omit.min

+
+

name#

+

• Optional name: string

+

Inherited from#

+

Omit.name

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCanPlayThroughCapture

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onChangeCapture

+
+

onChangeCommitted#

+

• Optional onChangeCommitted: (event: ChangeEvent<Object>, value: number | number[]) => void

+

Type declaration#

+

▸ (event, value): void

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
eventChangeEvent<Object>
valuenumber | number[]
+
Returns#
+

void

+

Inherited from#

+

Omit.onChangeCommitted

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLSpanElement>

+

Inherited from#

+

Omit.onWheelCapture

+
+

orientation#

+

• Optional orientation: "horizontal" | "vertical"

+

Inherited from#

+

Omit.orientation

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

Omit.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

Omit.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

Omit.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

Omit.radioGroup

+
+

ref#

+

• Optional ref: Ref<HTMLSpanElement>

+

Inherited from#

+

Omit.ref

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

Omit.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

Omit.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

Omit.role

+
+

scale#

+

• Optional scale: (value: number) => number

+

Type declaration#

+

▸ (value): number

+
Parameters#
+ + + + + + + + + + + + + +
NameType
valuenumber
+
Returns#
+

number

+

Inherited from#

+

Omit.scale

+
+

security#

+

• Optional security: string

+

Inherited from#

+

Omit.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

Omit.slot

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

Omit.spellCheck

+
+

step#

+

• Optional step: number

+

Inherited from#

+

Omit.step

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

Omit.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

Omit.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

Omit.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

Omit.tabIndex

+
+

title#

+

• Optional title: string

+

Inherited from#

+

Omit.title

+
+

track#

+

• Optional track: false | "normal" | "inverted"

+

Inherited from#

+

Omit.track

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

Omit.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

Omit.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

Omit.unselectable

+
+

value#

+

• Optional value: number | number[]

+

Inherited from#

+

Omit.value

+
+

valueLabelDisplay#

+

• Optional valueLabelDisplay: "on" | "off" | "auto"

+

Inherited from#

+

Omit.valueLabelDisplay

+
+

valueLabelFormat#

+

• Optional valueLabelFormat: string | (value: number, index: number) => ReactNode

+

Inherited from#

+

Omit.valueLabelFormat

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

Omit.vocab

+

Methods#

+

onChange#

+

▸ Optional onChange(evt, value): void

+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
evtFormEvent<any>
valuenumber
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.spinnerprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.spinnerprops/index.html new file mode 100644 index 0000000000..beff42acaf --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.spinnerprops/index.html @@ -0,0 +1,5649 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SpinnerProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: SpinnerProps#

+

Renderer.Component.SpinnerProps

+

Hierarchy#

+
    +
  • HTMLProps<any>
    • +
+

↳ SpinnerProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLProps.about

+
+

accept#

+

• Optional accept: string

+

Inherited from#

+

React.HTMLProps.accept

+
+

acceptCharset#

+

• Optional acceptCharset: string

+

Inherited from#

+

React.HTMLProps.acceptCharset

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLProps.accessKey

+
+

action#

+

• Optional action: string

+

Inherited from#

+

React.HTMLProps.action

+
+

allowFullScreen#

+

• Optional allowFullScreen: boolean

+

Inherited from#

+

React.HTMLProps.allowFullScreen

+
+

allowTransparency#

+

• Optional allowTransparency: boolean

+

Inherited from#

+

React.HTMLProps.allowTransparency

+
+

alt#

+

• Optional alt: string

+

Inherited from#

+

React.HTMLProps.alt

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLProps.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLProps.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLProps.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLProps.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLProps.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLProps.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLProps.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLProps.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLProps.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLProps.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLProps.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLProps.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLProps.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLProps.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLProps.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLProps.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLProps.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLProps.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLProps.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLProps.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLProps.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLProps.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLProps.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLProps.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuetext

+
+

as#

+

• Optional as: string

+

Inherited from#

+

React.HTMLProps.as

+
+

async#

+

• Optional async: boolean

+

Inherited from#

+

React.HTMLProps.async

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLProps.autoCapitalize

+
+

autoComplete#

+

• Optional autoComplete: string

+

Inherited from#

+

React.HTMLProps.autoComplete

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLProps.autoCorrect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

React.HTMLProps.autoFocus

+
+

autoPlay#

+

• Optional autoPlay: boolean

+

Inherited from#

+

React.HTMLProps.autoPlay

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLProps.autoSave

+
+

capture#

+

• Optional capture: string | boolean

+

Inherited from#

+

React.HTMLProps.capture

+
+

cellPadding#

+

• Optional cellPadding: string | number

+

Inherited from#

+

React.HTMLProps.cellPadding

+
+

cellSpacing#

+

• Optional cellSpacing: string | number

+

Inherited from#

+

React.HTMLProps.cellSpacing

+
+

center#

+

• Optional center: boolean

+
+

challenge#

+

• Optional challenge: string

+

Inherited from#

+

React.HTMLProps.challenge

+
+

charSet#

+

• Optional charSet: string

+

Inherited from#

+

React.HTMLProps.charSet

+
+

checked#

+

• Optional checked: boolean

+

Inherited from#

+

React.HTMLProps.checked

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLProps.children

+
+

cite#

+

• Optional cite: string

+

Inherited from#

+

React.HTMLProps.cite

+
+

classID#

+

• Optional classID: string

+

Inherited from#

+

React.HTMLProps.classID

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLProps.className

+
+

colSpan#

+

• Optional colSpan: number

+

Inherited from#

+

React.HTMLProps.colSpan

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLProps.color

+
+

cols#

+

• Optional cols: number

+

Inherited from#

+

React.HTMLProps.cols

+
+

content#

+

• Optional content: string

+

Inherited from#

+

React.HTMLProps.content

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLProps.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLProps.contextMenu

+
+

controls#

+

• Optional controls: boolean

+

Inherited from#

+

React.HTMLProps.controls

+
+

coords#

+

• Optional coords: string

+

Inherited from#

+

React.HTMLProps.coords

+
+

crossOrigin#

+

• Optional crossOrigin: string

+

Inherited from#

+

React.HTMLProps.crossOrigin

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLProps.dangerouslySetInnerHTML

+
+

data#

+

• Optional data: string

+

Inherited from#

+

React.HTMLProps.data

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLProps.datatype

+
+

dateTime#

+

• Optional dateTime: string

+

Inherited from#

+

React.HTMLProps.dateTime

+
+

default#

+

• Optional default: boolean

+

Inherited from#

+

React.HTMLProps.default

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLProps.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.defaultValue

+
+

defer#

+

• Optional defer: boolean

+

Inherited from#

+

React.HTMLProps.defer

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLProps.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Inherited from#

+

React.HTMLProps.disabled

+
+

download#

+

• Optional download: any

+

Inherited from#

+

React.HTMLProps.download

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLProps.draggable

+
+

encType#

+

• Optional encType: string

+

Inherited from#

+

React.HTMLProps.encType

+
+

form#

+

• Optional form: string

+

Inherited from#

+

React.HTMLProps.form

+
+

formAction#

+

• Optional formAction: string

+

Inherited from#

+

React.HTMLProps.formAction

+
+

formEncType#

+

• Optional formEncType: string

+

Inherited from#

+

React.HTMLProps.formEncType

+
+

formMethod#

+

• Optional formMethod: string

+

Inherited from#

+

React.HTMLProps.formMethod

+
+

formNoValidate#

+

• Optional formNoValidate: boolean

+

Inherited from#

+

React.HTMLProps.formNoValidate

+
+

formTarget#

+

• Optional formTarget: string

+

Inherited from#

+

React.HTMLProps.formTarget

+
+

frameBorder#

+

• Optional frameBorder: string | number

+

Inherited from#

+

React.HTMLProps.frameBorder

+
+

headers#

+

• Optional headers: string

+

Inherited from#

+

React.HTMLProps.headers

+
+

height#

+

• Optional height: string | number

+

Inherited from#

+

React.HTMLProps.height

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLProps.hidden

+
+

high#

+

• Optional high: number

+

Inherited from#

+

React.HTMLProps.high

+
+

href#

+

• Optional href: string

+

Inherited from#

+

React.HTMLProps.href

+
+

hrefLang#

+

• Optional hrefLang: string

+

Inherited from#

+

React.HTMLProps.hrefLang

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

React.HTMLProps.htmlFor

+
+

httpEquiv#

+

• Optional httpEquiv: string

+

Inherited from#

+

React.HTMLProps.httpEquiv

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLProps.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLProps.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLProps.inputMode

+
+

integrity#

+

• Optional integrity: string

+

Inherited from#

+

React.HTMLProps.integrity

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLProps.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLProps.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLProps.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLProps.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLProps.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLProps.itemType

+
+

key#

+

• Optional key: Key

+

Inherited from#

+

React.HTMLProps.key

+
+

keyParams#

+

• Optional keyParams: string

+

Inherited from#

+

React.HTMLProps.keyParams

+
+

keyType#

+

• Optional keyType: string

+

Inherited from#

+

React.HTMLProps.keyType

+
+

kind#

+

• Optional kind: string

+

Inherited from#

+

React.HTMLProps.kind

+
+

label#

+

• Optional label: string

+

Inherited from#

+

React.HTMLProps.label

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLProps.lang

+
+

list#

+

• Optional list: string

+

Inherited from#

+

React.HTMLProps.list

+
+

loop#

+

• Optional loop: boolean

+

Inherited from#

+

React.HTMLProps.loop

+
+

low#

+

• Optional low: number

+

Inherited from#

+

React.HTMLProps.low

+
+

manifest#

+

• Optional manifest: string

+

Inherited from#

+

React.HTMLProps.manifest

+
+

marginHeight#

+

• Optional marginHeight: number

+

Inherited from#

+

React.HTMLProps.marginHeight

+
+

marginWidth#

+

• Optional marginWidth: number

+

Inherited from#

+

React.HTMLProps.marginWidth

+
+

max#

+

• Optional max: string | number

+

Inherited from#

+

React.HTMLProps.max

+
+

maxLength#

+

• Optional maxLength: number

+

Inherited from#

+

React.HTMLProps.maxLength

+
+

media#

+

• Optional media: string

+

Inherited from#

+

React.HTMLProps.media

+
+

mediaGroup#

+

• Optional mediaGroup: string

+

Inherited from#

+

React.HTMLProps.mediaGroup

+
+

method#

+

• Optional method: string

+

Inherited from#

+

React.HTMLProps.method

+
+

min#

+

• Optional min: string | number

+

Inherited from#

+

React.HTMLProps.min

+
+

minLength#

+

• Optional minLength: number

+

Inherited from#

+

React.HTMLProps.minLength

+
+

multiple#

+

• Optional multiple: boolean

+

Inherited from#

+

React.HTMLProps.multiple

+
+

muted#

+

• Optional muted: boolean

+

Inherited from#

+

React.HTMLProps.muted

+
+

name#

+

• Optional name: string

+

Inherited from#

+

React.HTMLProps.name

+
+

noValidate#

+

• Optional noValidate: boolean

+

Inherited from#

+

React.HTMLProps.noValidate

+
+

nonce#

+

• Optional nonce: string

+

Inherited from#

+

React.HTMLProps.nonce

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheelCapture

+
+

open#

+

• Optional open: boolean

+

Inherited from#

+

React.HTMLProps.open

+
+

optimum#

+

• Optional optimum: number

+

Inherited from#

+

React.HTMLProps.optimum

+
+

pattern#

+

• Optional pattern: string

+

Inherited from#

+

React.HTMLProps.pattern

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLProps.placeholder

+
+

playsInline#

+

• Optional playsInline: boolean

+

Inherited from#

+

React.HTMLProps.playsInline

+
+

poster#

+

• Optional poster: string

+

Inherited from#

+

React.HTMLProps.poster

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLProps.prefix

+
+

preload#

+

• Optional preload: string

+

Inherited from#

+

React.HTMLProps.preload

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLProps.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLProps.radioGroup

+
+

readOnly#

+

• Optional readOnly: boolean

+

Inherited from#

+

React.HTMLProps.readOnly

+
+

ref#

+

• Optional ref: LegacyRef<any>

+

Inherited from#

+

React.HTMLProps.ref

+
+

rel#

+

• Optional rel: string

+

Inherited from#

+

React.HTMLProps.rel

+
+

required#

+

• Optional required: boolean

+

Inherited from#

+

React.HTMLProps.required

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLProps.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLProps.results

+
+

reversed#

+

• Optional reversed: boolean

+

Inherited from#

+

React.HTMLProps.reversed

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLProps.role

+
+

rowSpan#

+

• Optional rowSpan: number

+

Inherited from#

+

React.HTMLProps.rowSpan

+
+

rows#

+

• Optional rows: number

+

Inherited from#

+

React.HTMLProps.rows

+
+

sandbox#

+

• Optional sandbox: string

+

Inherited from#

+

React.HTMLProps.sandbox

+
+

scope#

+

• Optional scope: string

+

Inherited from#

+

React.HTMLProps.scope

+
+

scoped#

+

• Optional scoped: boolean

+

Inherited from#

+

React.HTMLProps.scoped

+
+

scrolling#

+

• Optional scrolling: string

+

Inherited from#

+

React.HTMLProps.scrolling

+
+

seamless#

+

• Optional seamless: boolean

+

Inherited from#

+

React.HTMLProps.seamless

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLProps.security

+
+

selected#

+

• Optional selected: boolean

+

Inherited from#

+

React.HTMLProps.selected

+
+

shape#

+

• Optional shape: string

+

Inherited from#

+

React.HTMLProps.shape

+
+

singleColor#

+

• Optional singleColor: boolean

+
+

size#

+

• Optional size: number

+

Inherited from#

+

React.HTMLProps.size

+
+

sizes#

+

• Optional sizes: string

+

Inherited from#

+

React.HTMLProps.sizes

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLProps.slot

+
+

span#

+

• Optional span: number

+

Inherited from#

+

React.HTMLProps.span

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLProps.spellCheck

+
+

src#

+

• Optional src: string

+

Inherited from#

+

React.HTMLProps.src

+
+

srcDoc#

+

• Optional srcDoc: string

+

Inherited from#

+

React.HTMLProps.srcDoc

+
+

srcLang#

+

• Optional srcLang: string

+

Inherited from#

+

React.HTMLProps.srcLang

+
+

srcSet#

+

• Optional srcSet: string

+

Inherited from#

+

React.HTMLProps.srcSet

+
+

start#

+

• Optional start: number

+

Inherited from#

+

React.HTMLProps.start

+
+

step#

+

• Optional step: string | number

+

Inherited from#

+

React.HTMLProps.step

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLProps.style

+
+

summary#

+

• Optional summary: string

+

Inherited from#

+

React.HTMLProps.summary

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLProps.tabIndex

+
+

target#

+

• Optional target: string

+

Inherited from#

+

React.HTMLProps.target

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLProps.title

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLProps.translate

+
+

type#

+

• Optional type: string

+

Inherited from#

+

React.HTMLProps.type

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLProps.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLProps.unselectable

+
+

useMap#

+

• Optional useMap: string

+

Inherited from#

+

React.HTMLProps.useMap

+
+

value#

+

• Optional value: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.value

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLProps.vocab

+
+

width#

+

• Optional width: string | number

+

Inherited from#

+

React.HTMLProps.width

+
+

wmode#

+

• Optional wmode: string

+

Inherited from#

+

React.HTMLProps.wmode

+
+

wrap#

+

• Optional wrap: string

+

Inherited from#

+

React.HTMLProps.wrap

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.statusbrickprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.statusbrickprops/index.html new file mode 100644 index 0000000000..eb7ff24967 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.statusbrickprops/index.html @@ -0,0 +1,4269 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBrickProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: StatusBrickProps#

+

Renderer.Component.StatusBrickProps

+

Hierarchy#

+ +

↳ StatusBrickProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLAttributes.about

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLAttributes.accessKey

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLAttributes.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLAttributes.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLAttributes.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLAttributes.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLAttributes.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLAttributes.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLAttributes.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLAttributes.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLAttributes.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLAttributes.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLAttributes.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLAttributes.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLAttributes.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLAttributes.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLAttributes.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLAttributes.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLAttributes.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLAttributes.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLAttributes.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLAttributes.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLAttributes.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLAttributes.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLAttributes.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLAttributes.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLAttributes.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLAttributes.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLAttributes.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLAttributes.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLAttributes.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLAttributes.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLAttributes.aria-valuetext

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLAttributes.autoCapitalize

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLAttributes.autoCorrect

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLAttributes.autoSave

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLAttributes.children

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLAttributes.className

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLAttributes.color

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLAttributes.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLAttributes.contextMenu

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLAttributes.dangerouslySetInnerHTML

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLAttributes.datatype

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLAttributes.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLAttributes.defaultValue

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLAttributes.dir

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLAttributes.draggable

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLAttributes.hidden

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLAttributes.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLAttributes.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLAttributes.inputMode

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLAttributes.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLAttributes.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLAttributes.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLAttributes.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLAttributes.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLAttributes.itemType

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLAttributes.lang

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLAttributes.onWheelCapture

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLAttributes.placeholder

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLAttributes.prefix

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLAttributes.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLAttributes.radioGroup

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLAttributes.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLAttributes.results

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLAttributes.role

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLAttributes.security

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLAttributes.slot

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLAttributes.spellCheck

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLAttributes.style

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLAttributes.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLAttributes.tabIndex

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLAttributes.title

+
+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+

Inherited from#

+

TooltipDecoratorProps.tooltip

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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

+

Inherited from#

+

TooltipDecoratorProps.tooltipOverrideDisabled

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLAttributes.translate

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLAttributes.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLAttributes.unselectable

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLAttributes.vocab

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.stepperprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.stepperprops/index.html new file mode 100644 index 0000000000..0a2ecab586 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.stepperprops/index.html @@ -0,0 +1,5638 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: StepperProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: StepperProps#

+

Renderer.Component.StepperProps

+

Hierarchy#

+
    +
  • HTMLProps<any>
    • +
+

↳ StepperProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

about#

+

• Optional about: string

+

Inherited from#

+

React.HTMLProps.about

+
+

accept#

+

• Optional accept: string

+

Inherited from#

+

React.HTMLProps.accept

+
+

acceptCharset#

+

• Optional acceptCharset: string

+

Inherited from#

+

React.HTMLProps.acceptCharset

+
+

accessKey#

+

• Optional accessKey: string

+

Inherited from#

+

React.HTMLProps.accessKey

+
+

action#

+

• Optional action: string

+

Inherited from#

+

React.HTMLProps.action

+
+

allowFullScreen#

+

• Optional allowFullScreen: boolean

+

Inherited from#

+

React.HTMLProps.allowFullScreen

+
+

allowTransparency#

+

• Optional allowTransparency: boolean

+

Inherited from#

+

React.HTMLProps.allowTransparency

+
+

alt#

+

• Optional alt: string

+

Inherited from#

+

React.HTMLProps.alt

+
+

aria-activedescendant#

+

• Optional aria-activedescendant: string

+

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Inherited from#

+

React.HTMLProps.aria-activedescendant

+
+

aria-atomic#

+

• Optional aria-atomic: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-atomic

+
+

aria-autocomplete#

+

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-autocomplete

+
+

aria-busy#

+

• Optional aria-busy: boolean | "true" | "false"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-busy

+
+

aria-checked#

+

• Optional aria-checked: boolean | "true" | "false" | "mixed"

+

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

see aria-pressed @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-checked

+
+

aria-colcount#

+

• Optional aria-colcount: number

+

Defines the total number of columns in a table, grid, or treegrid.

+

see aria-colindex.

+

Inherited from#

+

React.HTMLProps.aria-colcount

+
+

aria-colindex#

+

• Optional aria-colindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-colindex

+
+

aria-colspan#

+

• Optional aria-colspan: number

+

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-colindex @see aria-rowspan.

+

Inherited from#

+

React.HTMLProps.aria-colspan

+
+

aria-controls#

+

• Optional aria-controls: string

+

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

see aria-owns.

+

Inherited from#

+

React.HTMLProps.aria-controls

+
+

aria-current#

+

• Optional aria-current: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

+

Indicates the element that represents the current item within a container or set of related elements.

+

Inherited from#

+

React.HTMLProps.aria-current

+
+

aria-describedby#

+

• Optional aria-describedby: string

+

Identifies the element (or elements) that describes the object.

+

see aria-labelledby

+

Inherited from#

+

React.HTMLProps.aria-describedby

+
+

aria-details#

+

• Optional aria-details: string

+

Identifies the element that provides a detailed, extended description for the object.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-details

+
+

aria-disabled#

+

• Optional aria-disabled: boolean | "true" | "false"

+

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

see aria-hidden @see aria-readonly.

+

Inherited from#

+

React.HTMLProps.aria-disabled

+
+

aria-dropeffect#

+

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

+

Indicates what functions can be performed when a dragged object is released on the drop target.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-dropeffect

+
+

aria-errormessage#

+

• Optional aria-errormessage: string

+

Identifies the element that provides an error message for the object.

+

see aria-invalid @see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-errormessage

+
+

aria-expanded#

+

• Optional aria-expanded: boolean | "true" | "false"

+

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Inherited from#

+

React.HTMLProps.aria-expanded

+
+

aria-flowto#

+

• Optional aria-flowto: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-flowto

+
+

aria-grabbed#

+

• Optional aria-grabbed: boolean | "true" | "false"

+

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

deprecated in ARIA 1.1

+

Inherited from#

+

React.HTMLProps.aria-grabbed

+
+

aria-haspopup#

+

• Optional aria-haspopup: boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"

+

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Inherited from#

+

React.HTMLProps.aria-haspopup

+
+

aria-hidden#

+

• Optional aria-hidden: boolean | "true" | "false"

+

Indicates whether the element is exposed to an accessibility API.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-hidden

+
+

aria-invalid#

+

• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

+

Indicates the entered value does not conform to the format expected by the application.

+

see aria-errormessage.

+

Inherited from#

+

React.HTMLProps.aria-invalid

+
+

aria-keyshortcuts#

+

• Optional aria-keyshortcuts: string

+

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Inherited from#

+

React.HTMLProps.aria-keyshortcuts

+
+

aria-label#

+

• Optional aria-label: string

+

Defines a string value that labels the current element.

+

see aria-labelledby.

+

Inherited from#

+

React.HTMLProps.aria-label

+
+

aria-labelledby#

+

• Optional aria-labelledby: string

+

Identifies the element (or elements) that labels the current element.

+

see aria-describedby.

+

Inherited from#

+

React.HTMLProps.aria-labelledby

+
+

aria-level#

+

• Optional aria-level: number

+

Defines the hierarchical level of an element within a structure.

+

Inherited from#

+

React.HTMLProps.aria-level

+
+

aria-live#

+

• Optional aria-live: "off" | "assertive" | "polite"

+

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.

+

Inherited from#

+

React.HTMLProps.aria-live

+
+

aria-modal#

+

• Optional aria-modal: boolean | "true" | "false"

+

Indicates whether an element is modal when displayed.

+

Inherited from#

+

React.HTMLProps.aria-modal

+
+

aria-multiline#

+

• Optional aria-multiline: boolean | "true" | "false"

+

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Inherited from#

+

React.HTMLProps.aria-multiline

+
+

aria-multiselectable#

+

• Optional aria-multiselectable: boolean | "true" | "false"

+

Indicates that the user may select more than one item from the current selectable descendants.

+

Inherited from#

+

React.HTMLProps.aria-multiselectable

+
+

aria-orientation#

+

• Optional aria-orientation: "horizontal" | "vertical"

+

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Inherited from#

+

React.HTMLProps.aria-orientation

+
+

aria-owns#

+

• Optional aria-owns: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-owns

+
+

aria-placeholder#

+

• Optional aria-placeholder: string

+

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.

+

Inherited from#

+

React.HTMLProps.aria-placeholder

+
+

aria-posinset#

+

• Optional aria-posinset: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-posinset

+
+

aria-pressed#

+

• Optional aria-pressed: boolean | "true" | "false" | "mixed"

+

Indicates the current "pressed" state of toggle buttons.

+

see aria-checked @see aria-selected.

+

Inherited from#

+

React.HTMLProps.aria-pressed

+
+

aria-readonly#

+

• Optional aria-readonly: boolean | "true" | "false"

+

Indicates that the element is not editable, but is otherwise operable.

+

see aria-disabled.

+

Inherited from#

+

React.HTMLProps.aria-readonly

+
+

aria-relevant#

+

• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

+

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

see aria-atomic.

+

Inherited from#

+

React.HTMLProps.aria-relevant

+
+

aria-required#

+

• Optional aria-required: boolean | "true" | "false"

+

Indicates that user input is required on the element before a form may be submitted.

+

Inherited from#

+

React.HTMLProps.aria-required

+
+

aria-roledescription#

+

• Optional aria-roledescription: string

+

Defines a human-readable, author-localized description for the role of an element.

+

Inherited from#

+

React.HTMLProps.aria-roledescription

+
+

aria-rowcount#

+

• Optional aria-rowcount: number

+

Defines the total number of rows in a table, grid, or treegrid.

+

see aria-rowindex.

+

Inherited from#

+

React.HTMLProps.aria-rowcount

+
+

aria-rowindex#

+

• Optional aria-rowindex: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-rowindex

+
+

aria-rowspan#

+

• Optional aria-rowspan: number

+

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

see aria-rowindex @see aria-colspan.

+

Inherited from#

+

React.HTMLProps.aria-rowspan

+
+

aria-selected#

+

• Optional aria-selected: boolean | "true" | "false"

+

Indicates the current "selected" state of various widgets.

+

see aria-checked @see aria-pressed.

+

Inherited from#

+

React.HTMLProps.aria-selected

+
+

aria-setsize#

+

• Optional aria-setsize: number

+

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.

+

Inherited from#

+

React.HTMLProps.aria-setsize

+
+

aria-sort#

+

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

+

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Inherited from#

+

React.HTMLProps.aria-sort

+
+

aria-valuemax#

+

• Optional aria-valuemax: number

+

Defines the maximum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemax

+
+

aria-valuemin#

+

• Optional aria-valuemin: number

+

Defines the minimum allowed value for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuemin

+
+

aria-valuenow#

+

• Optional aria-valuenow: number

+

Defines the current value for a range widget.

+

see aria-valuetext.

+

Inherited from#

+

React.HTMLProps.aria-valuenow

+
+

aria-valuetext#

+

• Optional aria-valuetext: string

+

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Inherited from#

+

React.HTMLProps.aria-valuetext

+
+

as#

+

• Optional as: string

+

Inherited from#

+

React.HTMLProps.as

+
+

async#

+

• Optional async: boolean

+

Inherited from#

+

React.HTMLProps.async

+
+

autoCapitalize#

+

• Optional autoCapitalize: string

+

Inherited from#

+

React.HTMLProps.autoCapitalize

+
+

autoComplete#

+

• Optional autoComplete: string

+

Inherited from#

+

React.HTMLProps.autoComplete

+
+

autoCorrect#

+

• Optional autoCorrect: string

+

Inherited from#

+

React.HTMLProps.autoCorrect

+
+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

React.HTMLProps.autoFocus

+
+

autoPlay#

+

• Optional autoPlay: boolean

+

Inherited from#

+

React.HTMLProps.autoPlay

+
+

autoSave#

+

• Optional autoSave: string

+

Inherited from#

+

React.HTMLProps.autoSave

+
+

capture#

+

• Optional capture: string | boolean

+

Inherited from#

+

React.HTMLProps.capture

+
+

cellPadding#

+

• Optional cellPadding: string | number

+

Inherited from#

+

React.HTMLProps.cellPadding

+
+

cellSpacing#

+

• Optional cellSpacing: string | number

+

Inherited from#

+

React.HTMLProps.cellSpacing

+
+

challenge#

+

• Optional challenge: string

+

Inherited from#

+

React.HTMLProps.challenge

+
+

charSet#

+

• Optional charSet: string

+

Inherited from#

+

React.HTMLProps.charSet

+
+

checked#

+

• Optional checked: boolean

+

Inherited from#

+

React.HTMLProps.checked

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.HTMLProps.children

+
+

cite#

+

• Optional cite: string

+

Inherited from#

+

React.HTMLProps.cite

+
+

classID#

+

• Optional classID: string

+

Inherited from#

+

React.HTMLProps.classID

+
+

className#

+

• Optional className: string

+

Inherited from#

+

React.HTMLProps.className

+
+

colSpan#

+

• Optional colSpan: number

+

Inherited from#

+

React.HTMLProps.colSpan

+
+

color#

+

• Optional color: string

+

Inherited from#

+

React.HTMLProps.color

+
+

cols#

+

• Optional cols: number

+

Inherited from#

+

React.HTMLProps.cols

+
+

content#

+

• Optional content: string

+

Inherited from#

+

React.HTMLProps.content

+
+

contentEditable#

+

• Optional contentEditable: Booleanish | "inherit"

+

Inherited from#

+

React.HTMLProps.contentEditable

+
+

contextMenu#

+

• Optional contextMenu: string

+

Inherited from#

+

React.HTMLProps.contextMenu

+
+

controls#

+

• Optional controls: boolean

+

Inherited from#

+

React.HTMLProps.controls

+
+

coords#

+

• Optional coords: string

+

Inherited from#

+

React.HTMLProps.coords

+
+

crossOrigin#

+

• Optional crossOrigin: string

+

Inherited from#

+

React.HTMLProps.crossOrigin

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.HTMLProps.dangerouslySetInnerHTML

+
+

data#

+

• Optional data: string

+

Inherited from#

+

React.HTMLProps.data

+
+

datatype#

+

• Optional datatype: string

+

Inherited from#

+

React.HTMLProps.datatype

+
+

dateTime#

+

• Optional dateTime: string

+

Inherited from#

+

React.HTMLProps.dateTime

+
+

default#

+

• Optional default: boolean

+

Inherited from#

+

React.HTMLProps.default

+
+

defaultChecked#

+

• Optional defaultChecked: boolean

+

Inherited from#

+

React.HTMLProps.defaultChecked

+
+

defaultValue#

+

• Optional defaultValue: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.defaultValue

+
+

defer#

+

• Optional defer: boolean

+

Inherited from#

+

React.HTMLProps.defer

+
+

dir#

+

• Optional dir: string

+

Inherited from#

+

React.HTMLProps.dir

+
+

disabled#

+

• Optional disabled: boolean

+

Inherited from#

+

React.HTMLProps.disabled

+
+

download#

+

• Optional download: any

+

Inherited from#

+

React.HTMLProps.download

+
+

draggable#

+

• Optional draggable: Booleanish

+

Inherited from#

+

React.HTMLProps.draggable

+
+

encType#

+

• Optional encType: string

+

Inherited from#

+

React.HTMLProps.encType

+
+

form#

+

• Optional form: string

+

Inherited from#

+

React.HTMLProps.form

+
+

formAction#

+

• Optional formAction: string

+

Inherited from#

+

React.HTMLProps.formAction

+
+

formEncType#

+

• Optional formEncType: string

+

Inherited from#

+

React.HTMLProps.formEncType

+
+

formMethod#

+

• Optional formMethod: string

+

Inherited from#

+

React.HTMLProps.formMethod

+
+

formNoValidate#

+

• Optional formNoValidate: boolean

+

Inherited from#

+

React.HTMLProps.formNoValidate

+
+

formTarget#

+

• Optional formTarget: string

+

Inherited from#

+

React.HTMLProps.formTarget

+
+

frameBorder#

+

• Optional frameBorder: string | number

+

Inherited from#

+

React.HTMLProps.frameBorder

+
+

headers#

+

• Optional headers: string

+

Inherited from#

+

React.HTMLProps.headers

+
+

height#

+

• Optional height: string | number

+

Inherited from#

+

React.HTMLProps.height

+
+

hidden#

+

• Optional hidden: boolean

+

Inherited from#

+

React.HTMLProps.hidden

+
+

high#

+

• Optional high: number

+

Inherited from#

+

React.HTMLProps.high

+
+

href#

+

• Optional href: string

+

Inherited from#

+

React.HTMLProps.href

+
+

hrefLang#

+

• Optional hrefLang: string

+

Inherited from#

+

React.HTMLProps.hrefLang

+
+

htmlFor#

+

• Optional htmlFor: string

+

Inherited from#

+

React.HTMLProps.htmlFor

+
+

httpEquiv#

+

• Optional httpEquiv: string

+

Inherited from#

+

React.HTMLProps.httpEquiv

+
+

id#

+

• Optional id: string

+

Inherited from#

+

React.HTMLProps.id

+
+

inlist#

+

• Optional inlist: any

+

Inherited from#

+

React.HTMLProps.inlist

+
+

inputMode#

+

• Optional inputMode: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

+

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

+

Inherited from#

+

React.HTMLProps.inputMode

+
+

integrity#

+

• Optional integrity: string

+

Inherited from#

+

React.HTMLProps.integrity

+
+

is#

+

• Optional is: string

+

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

+

Inherited from#

+

React.HTMLProps.is

+
+

itemID#

+

• Optional itemID: string

+

Inherited from#

+

React.HTMLProps.itemID

+
+

itemProp#

+

• Optional itemProp: string

+

Inherited from#

+

React.HTMLProps.itemProp

+
+

itemRef#

+

• Optional itemRef: string

+

Inherited from#

+

React.HTMLProps.itemRef

+
+

itemScope#

+

• Optional itemScope: boolean

+

Inherited from#

+

React.HTMLProps.itemScope

+
+

itemType#

+

• Optional itemType: string

+

Inherited from#

+

React.HTMLProps.itemType

+
+

key#

+

• Optional key: Key

+

Inherited from#

+

React.HTMLProps.key

+
+

keyParams#

+

• Optional keyParams: string

+

Inherited from#

+

React.HTMLProps.keyParams

+
+

keyType#

+

• Optional keyType: string

+

Inherited from#

+

React.HTMLProps.keyType

+
+

kind#

+

• Optional kind: string

+

Inherited from#

+

React.HTMLProps.kind

+
+

label#

+

• Optional label: string

+

Inherited from#

+

React.HTMLProps.label

+
+

lang#

+

• Optional lang: string

+

Inherited from#

+

React.HTMLProps.lang

+
+

list#

+

• Optional list: string

+

Inherited from#

+

React.HTMLProps.list

+
+

loop#

+

• Optional loop: boolean

+

Inherited from#

+

React.HTMLProps.loop

+
+

low#

+

• Optional low: number

+

Inherited from#

+

React.HTMLProps.low

+
+

manifest#

+

• Optional manifest: string

+

Inherited from#

+

React.HTMLProps.manifest

+
+

marginHeight#

+

• Optional marginHeight: number

+

Inherited from#

+

React.HTMLProps.marginHeight

+
+

marginWidth#

+

• Optional marginWidth: number

+

Inherited from#

+

React.HTMLProps.marginWidth

+
+

max#

+

• Optional max: string | number

+

Inherited from#

+

React.HTMLProps.max

+
+

maxLength#

+

• Optional maxLength: number

+

Inherited from#

+

React.HTMLProps.maxLength

+
+

media#

+

• Optional media: string

+

Inherited from#

+

React.HTMLProps.media

+
+

mediaGroup#

+

• Optional mediaGroup: string

+

Inherited from#

+

React.HTMLProps.mediaGroup

+
+

method#

+

• Optional method: string

+

Inherited from#

+

React.HTMLProps.method

+
+

min#

+

• Optional min: string | number

+

Inherited from#

+

React.HTMLProps.min

+
+

minLength#

+

• Optional minLength: number

+

Inherited from#

+

React.HTMLProps.minLength

+
+

multiple#

+

• Optional multiple: boolean

+

Inherited from#

+

React.HTMLProps.multiple

+
+

muted#

+

• Optional muted: boolean

+

Inherited from#

+

React.HTMLProps.muted

+
+

name#

+

• Optional name: string

+

Inherited from#

+

React.HTMLProps.name

+
+

noValidate#

+

• Optional noValidate: boolean

+

Inherited from#

+

React.HTMLProps.noValidate

+
+

nonce#

+

• Optional nonce: string

+

Inherited from#

+

React.HTMLProps.nonce

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.HTMLProps.onWheelCapture

+
+

open#

+

• Optional open: boolean

+

Inherited from#

+

React.HTMLProps.open

+
+

optimum#

+

• Optional optimum: number

+

Inherited from#

+

React.HTMLProps.optimum

+
+

pattern#

+

• Optional pattern: string

+

Inherited from#

+

React.HTMLProps.pattern

+
+

placeholder#

+

• Optional placeholder: string

+

Inherited from#

+

React.HTMLProps.placeholder

+
+

playsInline#

+

• Optional playsInline: boolean

+

Inherited from#

+

React.HTMLProps.playsInline

+
+

poster#

+

• Optional poster: string

+

Inherited from#

+

React.HTMLProps.poster

+
+

prefix#

+

• Optional prefix: string

+

Inherited from#

+

React.HTMLProps.prefix

+
+

preload#

+

• Optional preload: string

+

Inherited from#

+

React.HTMLProps.preload

+
+

property#

+

• Optional property: string

+

Inherited from#

+

React.HTMLProps.property

+
+

radioGroup#

+

• Optional radioGroup: string

+

Inherited from#

+

React.HTMLProps.radioGroup

+
+

readOnly#

+

• Optional readOnly: boolean

+

Inherited from#

+

React.HTMLProps.readOnly

+
+

ref#

+

• Optional ref: LegacyRef<any>

+

Inherited from#

+

React.HTMLProps.ref

+
+

rel#

+

• Optional rel: string

+

Inherited from#

+

React.HTMLProps.rel

+
+

required#

+

• Optional required: boolean

+

Inherited from#

+

React.HTMLProps.required

+
+

resource#

+

• Optional resource: string

+

Inherited from#

+

React.HTMLProps.resource

+
+

results#

+

• Optional results: number

+

Inherited from#

+

React.HTMLProps.results

+
+

reversed#

+

• Optional reversed: boolean

+

Inherited from#

+

React.HTMLProps.reversed

+
+

role#

+

• Optional role: string

+

Inherited from#

+

React.HTMLProps.role

+
+

rowSpan#

+

• Optional rowSpan: number

+

Inherited from#

+

React.HTMLProps.rowSpan

+
+

rows#

+

• Optional rows: number

+

Inherited from#

+

React.HTMLProps.rows

+
+

sandbox#

+

• Optional sandbox: string

+

Inherited from#

+

React.HTMLProps.sandbox

+
+

scope#

+

• Optional scope: string

+

Inherited from#

+

React.HTMLProps.scope

+
+

scoped#

+

• Optional scoped: boolean

+

Inherited from#

+

React.HTMLProps.scoped

+
+

scrolling#

+

• Optional scrolling: string

+

Inherited from#

+

React.HTMLProps.scrolling

+
+

seamless#

+

• Optional seamless: boolean

+

Inherited from#

+

React.HTMLProps.seamless

+
+

security#

+

• Optional security: string

+

Inherited from#

+

React.HTMLProps.security

+
+

selected#

+

• Optional selected: boolean

+

Inherited from#

+

React.HTMLProps.selected

+
+

shape#

+

• Optional shape: string

+

Inherited from#

+

React.HTMLProps.shape

+
+

size#

+

• Optional size: number

+

Inherited from#

+

React.HTMLProps.size

+
+

sizes#

+

• Optional sizes: string

+

Inherited from#

+

React.HTMLProps.sizes

+
+

slot#

+

• Optional slot: string

+

Inherited from#

+

React.HTMLProps.slot

+
+

span#

+

• Optional span: number

+

Inherited from#

+

React.HTMLProps.span

+
+

spellCheck#

+

• Optional spellCheck: Booleanish

+

Inherited from#

+

React.HTMLProps.spellCheck

+
+

src#

+

• Optional src: string

+

Inherited from#

+

React.HTMLProps.src

+
+

srcDoc#

+

• Optional srcDoc: string

+

Inherited from#

+

React.HTMLProps.srcDoc

+
+

srcLang#

+

• Optional srcLang: string

+

Inherited from#

+

React.HTMLProps.srcLang

+
+

srcSet#

+

• Optional srcSet: string

+

Inherited from#

+

React.HTMLProps.srcSet

+
+

start#

+

• Optional start: number

+

Inherited from#

+

React.HTMLProps.start

+
+

step#

+

• step: number

+

Overrides#

+

React.HTMLProps.step

+
+

steps#

+

• steps: Step[]

+
+

style#

+

• Optional style: CSSProperties

+

Inherited from#

+

React.HTMLProps.style

+
+

summary#

+

• Optional summary: string

+

Inherited from#

+

React.HTMLProps.summary

+
+

suppressContentEditableWarning#

+

• Optional suppressContentEditableWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressContentEditableWarning

+
+

suppressHydrationWarning#

+

• Optional suppressHydrationWarning: boolean

+

Inherited from#

+

React.HTMLProps.suppressHydrationWarning

+
+

tabIndex#

+

• Optional tabIndex: number

+

Inherited from#

+

React.HTMLProps.tabIndex

+
+

target#

+

• Optional target: string

+

Inherited from#

+

React.HTMLProps.target

+
+

title#

+

• Optional title: string

+

Inherited from#

+

React.HTMLProps.title

+
+

translate#

+

• Optional translate: "yes" | "no"

+

Inherited from#

+

React.HTMLProps.translate

+
+

type#

+

• Optional type: string

+

Inherited from#

+

React.HTMLProps.type

+
+

typeof#

+

• Optional typeof: string

+

Inherited from#

+

React.HTMLProps.typeof

+
+

unselectable#

+

• Optional unselectable: "on" | "off"

+

Inherited from#

+

React.HTMLProps.unselectable

+
+

useMap#

+

• Optional useMap: string

+

Inherited from#

+

React.HTMLProps.useMap

+
+

value#

+

• Optional value: string | number | readonly string[]

+

Inherited from#

+

React.HTMLProps.value

+
+

vocab#

+

• Optional vocab: string

+

Inherited from#

+

React.HTMLProps.vocab

+
+

width#

+

• Optional width: string | number

+

Inherited from#

+

React.HTMLProps.width

+
+

wmode#

+

• Optional wmode: string

+

Inherited from#

+

React.HTMLProps.wmode

+
+

wrap#

+

• Optional wrap: string

+

Inherited from#

+

React.HTMLProps.wrap

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutprops/index.html new file mode 100644 index 0000000000..6721e58b1e --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutprops/index.html @@ -0,0 +1,869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TabLayoutProps#

+

Renderer.Component.TabLayoutProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

children#

+

• Optional children: ReactNode

+
+

className#

+

• Optional className: IClassName

+
+

contentClass#

+

• Optional contentClass: IClassName

+
+

tabs#

+

• Optional tabs: TabLayoutRoute[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutroute/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutroute/index.html new file mode 100644 index 0000000000..dab4748ce2 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutroute/index.html @@ -0,0 +1,891 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutRoute - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TabLayoutRoute#

+

Renderer.Component.TabLayoutRoute

+

Table of contents#

+

Properties#

+ +

Properties#

+

component#

+

• component: ComponentType<any>

+
+

default#

+

• Optional default: boolean

+
+

exact#

+

• Optional exact: boolean

+
+

routePath#

+

• routePath: string

+
+

title#

+

• title: ReactNode

+
+

url#

+

• Optional url: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tablecellprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tablecellprops/index.html new file mode 100644 index 0000000000..aa3e5e6cad --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tablecellprops/index.html @@ -0,0 +1,3119 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TableCellProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TableCellProps#

+

Renderer.Component.TableCellProps

+

Hierarchy#

+
    +
  • DOMAttributes<HTMLDivElement>
    • +
+

↳ TableCellProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

_nowrap#

+

• Optional _nowrap: boolean

+
+

_sorting#

+

• Optional _sorting: Partial<TableSortParams>

+
+

checkbox#

+

• Optional checkbox: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: string

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+

id#

+

• Optional id: string

+
+

isChecked#

+

• Optional isChecked: boolean

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+
+

renderBoolean#

+

• Optional renderBoolean: boolean

+
+

showWithColumn#

+

• Optional showWithColumn: string

+
+

sortBy#

+

• Optional sortBy: string

+
+

title#

+

• Optional title: ReactNode

+

Methods#

+

_sort#

+

▸ Optional _sort(sortBy): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
sortBystring
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tableheadprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tableheadprops/index.html new file mode 100644 index 0000000000..cc8004238d --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tableheadprops/index.html @@ -0,0 +1,3002 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TableHeadProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TableHeadProps#

+

Renderer.Component.TableHeadProps

+

Hierarchy#

+
    +
  • DOMAttributes<HTMLDivElement>
    • +
+

↳ TableHeadProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: string

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+

nowrap#

+

• Optional nowrap: boolean

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+
+

showTopLine#

+

• Optional showTopLine: boolean

+
+

sticky#

+

• Optional sticky: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tableprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tableprops/index.html new file mode 100644 index 0000000000..c23e70bbc0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tableprops/index.html @@ -0,0 +1,3273 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TableProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TableProps<Item>#

+

Renderer.Component.TableProps

+

Type parameters#

+ + + + + + + + + + + +
Name
Item
+

Hierarchy#

+
    +
  • DOMAttributes<HTMLDivElement>
    • +
+

↳ TableProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

autoSize#

+

• Optional autoSize: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: string

+
+

customRowHeights#

+

• Optional customRowHeights: (item: Item, lineHeight: number, paddings: number) => number

+

Type declaration#

+

▸ (item, lineHeight, paddings): number

+
Parameters#
+ + + + + + + + + + + + + + + + + + + + + +
NameType
itemItem
lineHeightnumber
paddingsnumber
+
Returns#
+

number

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+

getTableRow#

+

• Optional getTableRow: (uid: string) => ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+

Type declaration#

+

▸ (uid): ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+
Parameters#
+ + + + + + + + + + + + + +
NameType
uidstring
+
Returns#
+

ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+
+

items#

+

• Optional items: Item[]

+
+

noItems#

+

• Optional noItems: ReactNode

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onSort#

+

• Optional onSort: (params: TableSortParams) => void

+

Type declaration#

+

▸ (params): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
paramsTableSortParams
+
Returns#
+

void

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+
+

renderRow#

+

• Optional renderRow: (item: Item) => ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+

Type declaration#

+

▸ (item): ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+
Parameters#
+ + + + + + + + + + + + + +
NameType
itemItem
+
Returns#
+

ReactElement<TableRowProps, string | JSXElementConstructor<any>>

+
+

rowLineHeight#

+

• Optional rowLineHeight: string

+
+

rowPadding#

+

• Optional rowPadding: string

+
+

scrollable#

+

• Optional scrollable: boolean

+
+

selectable#

+

• Optional selectable: boolean

+
+

selectedItemId#

+

• Optional selectedItemId: string

+
+

sortByDefault#

+

• Optional sortByDefault: Partial<TableSortParams>

+
+

sortSyncWithUrl#

+

• Optional sortSyncWithUrl: boolean

+
+

sortable#

+

• Optional sortable: TableSortCallbacks<Item>

+

Define sortable callbacks for every column in

+

sortitem argument in the callback is an object, provided in

+
+

storageKey#

+

• Optional storageKey: string

+
+

tableId#

+

• Optional tableId: string

+
+

virtual#

+

• Optional virtual: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tablerowprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tablerowprops/index.html new file mode 100644 index 0000000000..1a75bdf6ea --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tablerowprops/index.html @@ -0,0 +1,3035 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TableRowProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TableRowProps#

+

Renderer.Component.TableRowProps

+

Hierarchy#

+
    +
  • DOMAttributes<HTMLDivElement>
    • +
+

↳ TableRowProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: string

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+

disabled#

+

• Optional disabled: boolean

+
+

nowrap#

+

• Optional nowrap: boolean

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLDivElement>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+
+

searchItem#

+

• Optional searchItem: any

+
+

selected#

+

• Optional selected: boolean

+
+

sortItem#

+

• Optional sortItem: any

+
+

style#

+

• Optional style: CSSProperties

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tabprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tabprops/index.html new file mode 100644 index 0000000000..9e3a0a36c0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tabprops/index.html @@ -0,0 +1,3057 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TabProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TabProps<D>#

+

Renderer.Component.TabProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
DD = any
+

Hierarchy#

+
    +
  • DOMAttributes<HTMLElement>
    • +
+

↳ TabProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

active#

+

• Optional active: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

DOMAttributes.children

+
+

className#

+

• Optional className: string

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

DOMAttributes.dangerouslySetInnerHTML

+
+

disabled#

+

• Optional disabled: boolean

+
+

icon#

+

• Optional icon: ReactNode

+
+

id#

+

• Optional id: string

+
+

label#

+

• Optional label: ReactNode

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLElement>

+

Inherited from#

+

DOMAttributes.onWheelCapture

+
+

value#

+

• value: D

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tabsprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tabsprops/index.html new file mode 100644 index 0000000000..724acb0fe0 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tabsprops/index.html @@ -0,0 +1,3108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TabsProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TabsProps<D>#

+

Renderer.Component.TabsProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
DD = any
+

Hierarchy#

+
    +
  • +

    TabsContextValue<D>

    +
    • +
  • +

    Omit<DOMAttributes<HTMLElement>, "onChange">

    +
    • +
+

↳ TabsProps

+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

autoFocus#

+

• Optional autoFocus: boolean

+

Inherited from#

+

TabsContextValue.autoFocus

+
+

center#

+

• Optional center: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

Omit.children

+
+

className#

+

• Optional className: string

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

Omit.dangerouslySetInnerHTML

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCanPlayThroughCapture

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<HTMLElement>

+

Inherited from#

+

Omit.onWheelCapture

+
+

scrollable#

+

• Optional scrollable: boolean

+
+

value#

+

• Optional value: D

+

Inherited from#

+

TabsContextValue.value

+
+

withBorder#

+

• Optional withBorder: boolean

+

Inherited from#

+

TabsContextValue.withBorder

+
+

wrap#

+

• Optional wrap: boolean

+

Methods#

+

onChange#

+

▸ Optional onChange(value): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valueD
+

Returns#

+

void

+

Inherited from#

+

TabsContextValue.onChange

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html new file mode 100644 index 0000000000..b7042ef860 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html @@ -0,0 +1,880 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipContentFormatters - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TooltipContentFormatters#

+

Renderer.Component.TooltipContentFormatters

+

Table of contents#

+

Properties#

+ +

Properties#

+

narrow#

+

• Optional narrow: boolean

+
+

nowrap#

+

• Optional nowrap: boolean

+
+

small#

+

• Optional small: boolean

+
+

tableView#

+

• Optional tableView: boolean

+
+

warning#

+

• Optional warning: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html new file mode 100644 index 0000000000..26b30e8567 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/index.html @@ -0,0 +1,865 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipDecoratorProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TooltipDecoratorProps#

+

Renderer.Component.TooltipDecoratorProps

+

Hierarchy#

+
    +
  • TooltipDecoratorProps
    • +
+

↳ ButtonProps

+

↳ IconProps

+

↳ BadgeProps

+

↳ LineProgressProps

+

↳ StatusBrickProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

tooltip#

+

• Optional tooltip: ReactNode | Omit<TooltipProps, "targetId">

+
+

tooltipOverrideDisabled#

+

• Optional tooltipOverrideDisabled: boolean

+

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/v5.2.6/extensions/api/interfaces/renderer.component.tooltipprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipprops/index.html new file mode 100644 index 0000000000..801fc42b93 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.tooltipprops/index.html @@ -0,0 +1,935 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: TooltipProps#

+

Renderer.Component.TooltipProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

children#

+

• Optional children: ReactNode

+
+

className#

+

• Optional className: IClassName

+
+

formatters#

+

• Optional formatters: TooltipContentFormatters

+
+

offset#

+

• Optional offset: number

+
+

preferredPositions#

+

• Optional preferredPositions: TooltipPosition | TooltipPosition[]

+
+

style#

+

• Optional style: CSSProperties

+
+

targetId#

+

• targetId: string

+
+

tooltipOnParentHover#

+

• Optional tooltipOnParentHover: boolean

+
+

usePortal#

+

• Optional usePortal: boolean

+
+

visible#

+

• Optional visible: boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html new file mode 100644 index 0000000000..e070d1fcf7 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html @@ -0,0 +1,3035 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: WizardLayoutProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: WizardLayoutProps#

+

Renderer.Component.WizardLayoutProps

+

Hierarchy#

+
    +
  • DOMAttributes<any>
    • +
+

↳ WizardLayoutProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

centered#

+

• Optional centered: boolean

+
+

children#

+

• Optional children: ReactNode

+

Inherited from#

+

React.DOMAttributes.children

+
+

className#

+

• Optional className: IClassName

+
+

contentClass#

+

• Optional contentClass: IClassName

+
+

dangerouslySetInnerHTML#

+

• Optional dangerouslySetInnerHTML: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
__htmlstring
+

Inherited from#

+

React.DOMAttributes.dangerouslySetInnerHTML

+
+ +

• Optional header: ReactNode

+
+

headerClass#

+

• Optional headerClass: IClassName

+
+

infoPanel#

+

• Optional infoPanel: ReactNode

+
+

infoPanelClass#

+

• Optional infoPanelClass: IClassName

+
+

onAbort#

+

• Optional onAbort: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAbort

+
+

onAbortCapture#

+

• Optional onAbortCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAbortCapture

+
+

onAnimationEnd#

+

• Optional onAnimationEnd: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationEnd

+
+

onAnimationEndCapture#

+

• Optional onAnimationEndCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationEndCapture

+
+

onAnimationIteration#

+

• Optional onAnimationIteration: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationIteration

+
+

onAnimationIterationCapture#

+

• Optional onAnimationIterationCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationIterationCapture

+
+

onAnimationStart#

+

• Optional onAnimationStart: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationStart

+
+

onAnimationStartCapture#

+

• Optional onAnimationStartCapture: AnimationEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAnimationStartCapture

+
+

onAuxClick#

+

• Optional onAuxClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAuxClick

+
+

onAuxClickCapture#

+

• Optional onAuxClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onAuxClickCapture

+
+

onBeforeInput#

+

• Optional onBeforeInput: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBeforeInput

+
+

onBeforeInputCapture#

+

• Optional onBeforeInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBeforeInputCapture

+
+

onBlur#

+

• Optional onBlur: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBlur

+
+

onBlurCapture#

+

• Optional onBlurCapture: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onBlurCapture

+
+

onCanPlay#

+

• Optional onCanPlay: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlay

+
+

onCanPlayCapture#

+

• Optional onCanPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayCapture

+
+

onCanPlayThrough#

+

• Optional onCanPlayThrough: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThrough

+
+

onCanPlayThroughCapture#

+

• Optional onCanPlayThroughCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCanPlayThroughCapture

+
+

onChange#

+

• Optional onChange: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onChange

+
+

onChangeCapture#

+

• Optional onChangeCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onChangeCapture

+
+

onClick#

+

• Optional onClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onClick

+
+

onClickCapture#

+

• Optional onClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onClickCapture

+
+

onCompositionEnd#

+

• Optional onCompositionEnd: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionEnd

+
+

onCompositionEndCapture#

+

• Optional onCompositionEndCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionEndCapture

+
+

onCompositionStart#

+

• Optional onCompositionStart: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionStart

+
+

onCompositionStartCapture#

+

• Optional onCompositionStartCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionStartCapture

+
+

onCompositionUpdate#

+

• Optional onCompositionUpdate: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdate

+
+

onCompositionUpdateCapture#

+

• Optional onCompositionUpdateCapture: CompositionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCompositionUpdateCapture

+
+

onContextMenu#

+

• Optional onContextMenu: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onContextMenu

+
+

onContextMenuCapture#

+

• Optional onContextMenuCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onContextMenuCapture

+
+

onCopy#

+

• Optional onCopy: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCopy

+
+

onCopyCapture#

+

• Optional onCopyCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCopyCapture

+
+

onCut#

+

• Optional onCut: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCut

+
+

onCutCapture#

+

• Optional onCutCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onCutCapture

+
+

onDoubleClick#

+

• Optional onDoubleClick: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDoubleClick

+
+

onDoubleClickCapture#

+

• Optional onDoubleClickCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDoubleClickCapture

+
+

onDrag#

+

• Optional onDrag: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDrag

+
+

onDragCapture#

+

• Optional onDragCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragCapture

+
+

onDragEnd#

+

• Optional onDragEnd: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnd

+
+

onDragEndCapture#

+

• Optional onDragEndCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEndCapture

+
+

onDragEnter#

+

• Optional onDragEnter: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnter

+
+

onDragEnterCapture#

+

• Optional onDragEnterCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragEnterCapture

+
+

onDragExit#

+

• Optional onDragExit: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragExit

+
+

onDragExitCapture#

+

• Optional onDragExitCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragExitCapture

+
+

onDragLeave#

+

• Optional onDragLeave: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragLeave

+
+

onDragLeaveCapture#

+

• Optional onDragLeaveCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragLeaveCapture

+
+

onDragOver#

+

• Optional onDragOver: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragOver

+
+

onDragOverCapture#

+

• Optional onDragOverCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragOverCapture

+
+

onDragStart#

+

• Optional onDragStart: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragStart

+
+

onDragStartCapture#

+

• Optional onDragStartCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDragStartCapture

+
+

onDrop#

+

• Optional onDrop: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDrop

+
+

onDropCapture#

+

• Optional onDropCapture: DragEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDropCapture

+
+

onDurationChange#

+

• Optional onDurationChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDurationChange

+
+

onDurationChangeCapture#

+

• Optional onDurationChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onDurationChangeCapture

+
+

onEmptied#

+

• Optional onEmptied: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEmptied

+
+

onEmptiedCapture#

+

• Optional onEmptiedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEmptiedCapture

+
+

onEncrypted#

+

• Optional onEncrypted: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEncrypted

+
+

onEncryptedCapture#

+

• Optional onEncryptedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEncryptedCapture

+
+

onEnded#

+

• Optional onEnded: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEnded

+
+

onEndedCapture#

+

• Optional onEndedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onEndedCapture

+
+

onError#

+

• Optional onError: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onError

+
+

onErrorCapture#

+

• Optional onErrorCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onErrorCapture

+
+

onFocus#

+

• Optional onFocus: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onFocus

+
+

onFocusCapture#

+

• Optional onFocusCapture: FocusEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onFocusCapture

+
+

onGotPointerCapture#

+

• Optional onGotPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCapture

+
+

onGotPointerCaptureCapture#

+

• Optional onGotPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onGotPointerCaptureCapture

+
+

onInput#

+

• Optional onInput: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInput

+
+

onInputCapture#

+

• Optional onInputCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInputCapture

+
+

onInvalid#

+

• Optional onInvalid: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInvalid

+
+

onInvalidCapture#

+

• Optional onInvalidCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onInvalidCapture

+
+

onKeyDown#

+

• Optional onKeyDown: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyDown

+
+

onKeyDownCapture#

+

• Optional onKeyDownCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyDownCapture

+
+

onKeyPress#

+

• Optional onKeyPress: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyPress

+
+

onKeyPressCapture#

+

• Optional onKeyPressCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyPressCapture

+
+

onKeyUp#

+

• Optional onKeyUp: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyUp

+
+

onKeyUpCapture#

+

• Optional onKeyUpCapture: KeyboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onKeyUpCapture

+
+

onLoad#

+

• Optional onLoad: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoad

+
+

onLoadCapture#

+

• Optional onLoadCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadCapture

+
+

onLoadStart#

+

• Optional onLoadStart: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadStart

+
+

onLoadStartCapture#

+

• Optional onLoadStartCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadStartCapture

+
+

onLoadedData#

+

• Optional onLoadedData: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedData

+
+

onLoadedDataCapture#

+

• Optional onLoadedDataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedDataCapture

+
+

onLoadedMetadata#

+

• Optional onLoadedMetadata: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadata

+
+

onLoadedMetadataCapture#

+

• Optional onLoadedMetadataCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLoadedMetadataCapture

+
+

onLostPointerCapture#

+

• Optional onLostPointerCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCapture

+
+

onLostPointerCaptureCapture#

+

• Optional onLostPointerCaptureCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onLostPointerCaptureCapture

+
+

onMouseDown#

+

• Optional onMouseDown: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseDown

+
+

onMouseDownCapture#

+

• Optional onMouseDownCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseDownCapture

+
+

onMouseEnter#

+

• Optional onMouseEnter: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseEnter

+
+

onMouseLeave#

+

• Optional onMouseLeave: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseLeave

+
+

onMouseMove#

+

• Optional onMouseMove: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseMove

+
+

onMouseMoveCapture#

+

• Optional onMouseMoveCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseMoveCapture

+
+

onMouseOut#

+

• Optional onMouseOut: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOut

+
+

onMouseOutCapture#

+

• Optional onMouseOutCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOutCapture

+
+

onMouseOver#

+

• Optional onMouseOver: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOver

+
+

onMouseOverCapture#

+

• Optional onMouseOverCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseOverCapture

+
+

onMouseUp#

+

• Optional onMouseUp: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseUp

+
+

onMouseUpCapture#

+

• Optional onMouseUpCapture: MouseEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onMouseUpCapture

+
+

onPaste#

+

• Optional onPaste: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPaste

+
+

onPasteCapture#

+

• Optional onPasteCapture: ClipboardEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPasteCapture

+
+

onPause#

+

• Optional onPause: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPause

+
+

onPauseCapture#

+

• Optional onPauseCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPauseCapture

+
+

onPlay#

+

• Optional onPlay: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlay

+
+

onPlayCapture#

+

• Optional onPlayCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlayCapture

+
+

onPlaying#

+

• Optional onPlaying: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlaying

+
+

onPlayingCapture#

+

• Optional onPlayingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPlayingCapture

+
+

onPointerCancel#

+

• Optional onPointerCancel: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerCancel

+
+

onPointerCancelCapture#

+

• Optional onPointerCancelCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerCancelCapture

+
+

onPointerDown#

+

• Optional onPointerDown: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerDown

+
+

onPointerDownCapture#

+

• Optional onPointerDownCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerDownCapture

+
+

onPointerEnter#

+

• Optional onPointerEnter: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerEnter

+
+

onPointerEnterCapture#

+

• Optional onPointerEnterCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerEnterCapture

+
+

onPointerLeave#

+

• Optional onPointerLeave: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerLeave

+
+

onPointerLeaveCapture#

+

• Optional onPointerLeaveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerLeaveCapture

+
+

onPointerMove#

+

• Optional onPointerMove: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerMove

+
+

onPointerMoveCapture#

+

• Optional onPointerMoveCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerMoveCapture

+
+

onPointerOut#

+

• Optional onPointerOut: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOut

+
+

onPointerOutCapture#

+

• Optional onPointerOutCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOutCapture

+
+

onPointerOver#

+

• Optional onPointerOver: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOver

+
+

onPointerOverCapture#

+

• Optional onPointerOverCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerOverCapture

+
+

onPointerUp#

+

• Optional onPointerUp: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerUp

+
+

onPointerUpCapture#

+

• Optional onPointerUpCapture: PointerEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onPointerUpCapture

+
+

onProgress#

+

• Optional onProgress: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onProgress

+
+

onProgressCapture#

+

• Optional onProgressCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onProgressCapture

+
+

onRateChange#

+

• Optional onRateChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onRateChange

+
+

onRateChangeCapture#

+

• Optional onRateChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onRateChangeCapture

+
+

onReset#

+

• Optional onReset: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onReset

+
+

onResetCapture#

+

• Optional onResetCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onResetCapture

+
+

onScroll#

+

• Optional onScroll: UIEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onScroll

+
+

onScrollCapture#

+

• Optional onScrollCapture: UIEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onScrollCapture

+
+

onSeeked#

+

• Optional onSeeked: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeeked

+
+

onSeekedCapture#

+

• Optional onSeekedCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeekedCapture

+
+

onSeeking#

+

• Optional onSeeking: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeeking

+
+

onSeekingCapture#

+

• Optional onSeekingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSeekingCapture

+
+

onSelect#

+

• Optional onSelect: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSelect

+
+

onSelectCapture#

+

• Optional onSelectCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSelectCapture

+
+

onStalled#

+

• Optional onStalled: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onStalled

+
+

onStalledCapture#

+

• Optional onStalledCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onStalledCapture

+
+

onSubmit#

+

• Optional onSubmit: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSubmit

+
+

onSubmitCapture#

+

• Optional onSubmitCapture: FormEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSubmitCapture

+
+

onSuspend#

+

• Optional onSuspend: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSuspend

+
+

onSuspendCapture#

+

• Optional onSuspendCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onSuspendCapture

+
+

onTimeUpdate#

+

• Optional onTimeUpdate: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdate

+
+

onTimeUpdateCapture#

+

• Optional onTimeUpdateCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTimeUpdateCapture

+
+

onTouchCancel#

+

• Optional onTouchCancel: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchCancel

+
+

onTouchCancelCapture#

+

• Optional onTouchCancelCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchCancelCapture

+
+

onTouchEnd#

+

• Optional onTouchEnd: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchEnd

+
+

onTouchEndCapture#

+

• Optional onTouchEndCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchEndCapture

+
+

onTouchMove#

+

• Optional onTouchMove: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchMove

+
+

onTouchMoveCapture#

+

• Optional onTouchMoveCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchMoveCapture

+
+

onTouchStart#

+

• Optional onTouchStart: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchStart

+
+

onTouchStartCapture#

+

• Optional onTouchStartCapture: TouchEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTouchStartCapture

+
+

onTransitionEnd#

+

• Optional onTransitionEnd: TransitionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTransitionEnd

+
+

onTransitionEndCapture#

+

• Optional onTransitionEndCapture: TransitionEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onTransitionEndCapture

+
+

onVolumeChange#

+

• Optional onVolumeChange: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onVolumeChange

+
+

onVolumeChangeCapture#

+

• Optional onVolumeChangeCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onVolumeChangeCapture

+
+

onWaiting#

+

• Optional onWaiting: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWaiting

+
+

onWaitingCapture#

+

• Optional onWaitingCapture: ReactEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWaitingCapture

+
+

onWheel#

+

• Optional onWheel: WheelEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWheel

+
+

onWheelCapture#

+

• Optional onWheelCapture: WheelEventHandler<any>

+

Inherited from#

+

React.DOMAttributes.onWheelCapture

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.wizardprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.wizardprops/index.html new file mode 100644 index 0000000000..d02b58d3bb --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.wizardprops/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: WizardProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: WizardProps#

+

Renderer.Component.WizardProps

+

Hierarchy#

+
    +
  • WizardCommonProps
    • +
+

↳ WizardProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

className#

+

• Optional className: string

+
+

data#

+

• Optional data: Partial<any>

+

Inherited from#

+

WizardCommonProps.data

+
+

done#

+

• Optional done: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.done

+
+ +

• Optional header: ReactNode

+
+

hideSteps#

+

• Optional hideSteps: boolean

+

Inherited from#

+

WizardCommonProps.hideSteps

+
+

onChange#

+

• Optional onChange: (step: number) => void

+

Type declaration#

+

▸ (step): void

+
Parameters#
+ + + + + + + + + + + + + +
NameType
stepnumber
+
Returns#
+

void

+
+

reset#

+

• Optional reset: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.reset

+
+

save#

+

• Optional save: (data: Partial, callback?: () => void) => void

+

Type declaration#

+

▸ (data, callback?): void

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
dataPartial<any>
callback?() => void
+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.save

+
+

step#

+

• Optional step: number

+
+

title#

+

• Optional title: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.component.wizardstepprops/index.html b/v5.2.6/extensions/api/interfaces/renderer.component.wizardstepprops/index.html new file mode 100644 index 0000000000..98d695c41c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.component.wizardstepprops/index.html @@ -0,0 +1,1254 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: WizardStepProps - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: WizardStepProps<D>#

+

Renderer.Component.WizardStepProps

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
DD = any
+

Hierarchy#

+
    +
  • WizardCommonProps<D>
    • +
+

↳ WizardStepProps

+

Table of contents#

+

Properties#

+ +

Properties#

+

afterContent#

+

• Optional afterContent: ReactNode

+
+

beforeContent#

+

• Optional beforeContent: ReactNode

+
+

className#

+

• Optional className: string | object

+
+

contentClass#

+

• Optional contentClass: string | object

+
+

customButtons#

+

• Optional customButtons: ReactNode

+
+

data#

+

• Optional data: Partial<D>

+

Inherited from#

+

WizardCommonProps.data

+
+

disabledNext#

+

• Optional disabledNext: boolean

+
+

done#

+

• Optional done: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.done

+
+

first#

+

• Optional first: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

hideBackBtn#

+

• Optional hideBackBtn: boolean

+
+

hideNextBtn#

+

• Optional hideNextBtn: boolean

+
+

hideSteps#

+

• Optional hideSteps: boolean

+

Inherited from#

+

WizardCommonProps.hideSteps

+
+

isFirst#

+

• Optional isFirst: () => boolean

+

Type declaration#

+

▸ (): boolean

+
Returns#
+

boolean

+
+

isLast#

+

• Optional isLast: () => boolean

+

Type declaration#

+

▸ (): boolean

+
Returns#
+

boolean

+
+

last#

+

• Optional last: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

loading#

+

• Optional loading: boolean

+
+

moreButtons#

+

• Optional moreButtons: ReactNode

+
+

next#

+

• Optional next: () => boolean | void | Promise<any>

+

Type declaration#

+

▸ (): boolean | void | Promise<any>

+
Returns#
+

boolean | void | Promise<any>

+
+

nextLabel#

+

• Optional nextLabel: ReactNode

+
+

noValidate#

+

• Optional noValidate: boolean

+
+

prev#

+

• Optional prev: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+
+

prevLabel#

+

• Optional prevLabel: ReactNode

+
+

reset#

+

• Optional reset: () => void

+

Type declaration#

+

▸ (): void

+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.reset

+
+

save#

+

• Optional save: (data: Partial, callback?: () => void) => void

+

Type declaration#

+

▸ (data, callback?): void

+
Parameters#
+ + + + + + + + + + + + + + + + + +
NameType
dataPartial<D>
callback?() => void
+
Returns#
+

void

+

Inherited from#

+

WizardCommonProps.save

+
+

scrollable#

+

• Optional scrollable: boolean

+
+

skip#

+

• Optional skip: boolean

+
+

step#

+

• Optional step: number

+
+

title#

+

• Optional title: string

+
+

waiting#

+

• Optional waiting: boolean

+
+

wizard#

+

• Optional wizard: Wizard

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html new file mode 100644 index 0000000000..998916b578 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/index.html @@ -0,0 +1,851 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IKubeApiCluster - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IKubeApiCluster#

+

Renderer.K8sApi.IKubeApiCluster

+

Table of contents#

+

Properties#

+ +

Properties#

+

metadata#

+

• metadata: Object

+

Type declaration#

+ + + + + + + + + + + + + +
NameType
uidstring
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html new file mode 100644 index 0000000000..12afe69758 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainer - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IPodContainer#

+

Renderer.K8sApi.IPodContainer

+

Table of contents#

+

Properties#

+ +

Properties#

+

args#

+

• Optional args: string[]

+
+

command#

+

• Optional command: string[]

+
+

env#

+

• Optional env: { name: string ; value?: string ; valueFrom?: { configMapKeyRef?: { key: string ; name: string } ; fieldRef?: { apiVersion: string ; fieldPath: string } ; secretKeyRef?: { key: string ; name: string } } }[]

+
+

envFrom#

+

• Optional envFrom: { configMapRef?: { name: string } ; secretRef?: { name: string } }[]

+
+

image#

+

• image: string

+
+

imagePullPolicy#

+

• imagePullPolicy: string

+
+

livenessProbe#

+

• Optional livenessProbe: IContainerProbe

+
+

name#

+

• name: string

+
+

ports#

+

• Optional ports: { containerPort: number ; name?: string ; protocol: string }[]

+
+

readinessProbe#

+

• Optional readinessProbe: IContainerProbe

+
+

resources#

+

• Optional resources: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
limitsObject
limits.cpustring
limits.memorystring
requestsObject
requests.cpustring
requests.memorystring
+
+

startupProbe#

+

• Optional startupProbe: IContainerProbe

+
+

volumeMounts#

+

• Optional volumeMounts: { mountPath: string ; name: string ; readOnly: boolean }[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html new file mode 100644 index 0000000000..b070945fc5 --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/index.html @@ -0,0 +1,1030 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainerStatus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IPodContainerStatus#

+

Renderer.K8sApi.IPodContainerStatus

+

Table of contents#

+

Properties#

+ +

Properties#

+

containerID#

+

• Optional containerID: string

+
+

image#

+

• image: string

+
+

imageID#

+

• imageID: string

+
+

lastState#

+

• Optional lastState: Object

+

Index signature#

+

▪ [index: string]: object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
running?Object
running.startedAtstring
terminated?Object
terminated.exitCodenumber
terminated.finishedAtstring
terminated.reasonstring
terminated.startedAtstring
waiting?Object
waiting.messagestring
waiting.reasonstring
+
+

name#

+

• name: string

+
+

ready#

+

• ready: boolean

+
+

restartCount#

+

• restartCount: number

+
+

started#

+

• Optional started: boolean

+
+

state#

+

• Optional state: Object

+

Index signature#

+

▪ [index: string]: object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
running?Object
running.startedAtstring
terminated?Object
terminated.exitCodenumber
terminated.finishedAtstring
terminated.reasonstring
terminated.startedAtstring
waiting?Object
waiting.messagestring
waiting.reasonstring
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html new file mode 100644 index 0000000000..ea30d0b63c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.k8sapi.isecretref/index.html @@ -0,0 +1,847 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ISecretRef - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ISecretRef#

+

Renderer.K8sApi.ISecretRef

+

Table of contents#

+

Properties#

+ +

Properties#

+

key#

+

• Optional key: string

+
+

name#

+

• name: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html b/v5.2.6/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html new file mode 100644 index 0000000000..57ed4f767b --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.navigation.pageparaminit/index.html @@ -0,0 +1,959 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageParamInit - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: PageParamInit<V>#

+

Renderer.Navigation.PageParamInit

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
VV = any
+

Table of contents#

+

Properties#

+ +

Methods#

+ +

Properties#

+

defaultValue#

+

• Optional defaultValue: V

+
+

name#

+

• name: string

+
+

prefix#

+

• Optional prefix: string

+

Methods#

+

parse#

+

▸ Optional parse(value): V

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valuestring | string[]
+

Returns#

+

V

+
+

stringify#

+

▸ Optional stringify(value): string | string[]

+

Parameters#

+ + + + + + + + + + + + + +
NameType
valueV
+

Returns#

+

string | string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/interfaces/renderer.navigation.urlparams/index.html b/v5.2.6/extensions/api/interfaces/renderer.navigation.urlparams/index.html new file mode 100644 index 0000000000..9690c81d3c --- /dev/null +++ b/v5.2.6/extensions/api/interfaces/renderer.navigation.urlparams/index.html @@ -0,0 +1,884 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: URLParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: URLParams<P, Q>#

+

Renderer.Navigation.URLParams

+

Type parameters#

+ + + + + + + + + + + + + + + + + +
NameType
PP: object = {}
QQ: object = {}
+

Table of contents#

+

Properties#

+ +

Properties#

+

fragment#

+

• Optional fragment: string

+
+

params#

+

• Optional params: P

+
+

query#

+

• Optional query: Q

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.app/index.html b/v5.2.6/extensions/api/modules/common.app/index.html new file mode 100644 index 0000000000..a3a435e935 --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.app/index.html @@ -0,0 +1,949 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: App - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: App#

+

Common.App

+

Table of contents#

+

Variables#

+ +

Functions#

+ +

Variables#

+

appName#

+

• Const appName: string

+
+

isLinux#

+

• Const isLinux: boolean

+
+

isMac#

+

• Const isMac: boolean

+
+

isSnap#

+

• Const isSnap: boolean = !!process.env.SNAP

+
+

isWindows#

+

• Const isWindows: boolean

+
+

issuesTrackerUrl#

+

• Const issuesTrackerUrl: string

+
+

slackUrl#

+

• Const slackUrl: string

+
+

version#

+

• Const version: string

+

Functions#

+

getEnabledExtensions#

+

▸ getEnabledExtensions(): string[]

+

Returns#

+

string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.catalog/index.html b/v5.2.6/extensions/api/modules/common.catalog/index.html new file mode 100644 index 0000000000..b614b3f14a --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.catalog/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Catalog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Catalog#

+

Common.Catalog

+

Table of contents#

+

Classes#

+ +

Interfaces#

+ +

Type aliases#

+ +

Variables#

+ +

Type aliases#

+

CatalogEntityConstructor#

+

Ƭ CatalogEntityConstructor<Entity>: (data: CatalogEntityData<ExtractEntityMetadataType<Entity>, ExtractEntityStatusType<Entity>, ExtractEntitySpecType\>) => Entity

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EntityEntity: CatalogEntity
+

Type declaration#

+

• (data)

+
Parameters#
+ + + + + + + + + + + + + +
NameType
dataCatalogEntityData<ExtractEntityMetadataType<Entity>, ExtractEntityStatusType<Entity>, ExtractEntitySpecType<Entity>>
+
+

CatalogEntitySpec#

+

Ƭ CatalogEntitySpec: Record<string, any>

+
+

KubernetesClusterStatusPhase#

+

Ƭ KubernetesClusterStatusPhase: "connected" | "connecting" | "disconnected" | "deleting"

+
+

WebLinkSpec#

+

Ƭ WebLinkSpec: Object

+

Type declaration#

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

WebLinkStatusPhase#

+

Ƭ WebLinkStatusPhase: "available" | "unavailable"

+

Variables#

+

kubernetesClusterCategory#

+

• Const kubernetesClusterCategory: KubernetesClusterCategory

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.eventbus/index.html b/v5.2.6/extensions/api/modules/common.eventbus/index.html new file mode 100644 index 0000000000..43671ce461 --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.eventbus/index.html @@ -0,0 +1,908 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: EventBus - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: EventBus#

+

Common.EventBus

+

Table of contents#

+

Type aliases#

+ +

Variables#

+ +

Type aliases#

+

AppEvent#

+

Ƭ AppEvent: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
actionstring
namestring
params?object
+

Variables#

+

appEventBus#

+

• Const appEventBus: EventEmitter<[AppEvent]>

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.store/index.html b/v5.2.6/extensions/api/modules/common.store/index.html new file mode 100644 index 0000000000..3dad0a794e --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.store/index.html @@ -0,0 +1,813 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Store - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.types/index.html b/v5.2.6/extensions/api/modules/common.types/index.html new file mode 100644 index 0000000000..809ad2e053 --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.types/index.html @@ -0,0 +1,902 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Types - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Types#

+

Common.Types

+

Table of contents#

+

Interfaces#

+ +

Type aliases#

+ +

Type aliases#

+

IpcMainEvent#

+

Ƭ IpcMainEvent: Electron.IpcMainEvent

+
+

IpcMainInvokeEvent#

+

Ƭ IpcMainInvokeEvent: Electron.IpcMainInvokeEvent

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+

IpcRendererEvent#

+

Ƭ IpcRendererEvent: Electron.IpcRendererEvent

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common.util/index.html b/v5.2.6/extensions/api/modules/common.util/index.html new file mode 100644 index 0000000000..cdfe16ea47 --- /dev/null +++ b/v5.2.6/extensions/api/modules/common.util/index.html @@ -0,0 +1,981 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Util - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Util#

+

Common.Util

+

Table of contents#

+

Classes#

+ +

Functions#

+ +

Functions#

+

cssNames#

+

▸ cssNames(...args): string

+

Parameters#

+ + + + + + + + + + + + + +
NameType
...argsIClassName[]
+

Returns#

+

string

+
+

openExternal#

+

▸ openExternal(url): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+
+

prevDefault#

+

▸ prevDefault(callback): (evt: E) => any

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
EE: Event | SyntheticEvent<Element, Event>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
callback(evt: E) => any
+

Returns#

+

fn

+

▸ (evt): any

+
Parameters#
+ + + + + + + + + + + + + +
NameType
evtE
+
Returns#
+

any

+
+

stopPropagation#

+

▸ stopPropagation(evt): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
evtEvent | React.SyntheticEvent
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/common/index.html b/v5.2.6/extensions/api/modules/common/index.html new file mode 100644 index 0000000000..2193518ded --- /dev/null +++ b/v5.2.6/extensions/api/modules/common/index.html @@ -0,0 +1,851 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Common - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/index.html b/v5.2.6/extensions/api/modules/index.html new file mode 100644 index 0000000000..6ff89b4ab3 --- /dev/null +++ b/v5.2.6/extensions/api/modules/index.html @@ -0,0 +1,814 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @k8slens/extensions - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

@k8slens/extensions#

+

Table of contents#

+

Namespaces#

+ + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/main.catalog/index.html b/v5.2.6/extensions/api/modules/main.catalog/index.html new file mode 100644 index 0000000000..5a9d60e767 --- /dev/null +++ b/v5.2.6/extensions/api/modules/main.catalog/index.html @@ -0,0 +1,881 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Catalog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/main.k8sapi/index.html b/v5.2.6/extensions/api/modules/main.k8sapi/index.html new file mode 100644 index 0000000000..99772ac5f3 --- /dev/null +++ b/v5.2.6/extensions/api/modules/main.k8sapi/index.html @@ -0,0 +1,1639 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: K8sApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: K8sApi#

+

Main.K8sApi

+

Table of contents#

+

References#

+ +

References#

+

ClusterRole#

+

Re-exports: ClusterRole

+
+

ClusterRoleBinding#

+

Re-exports: ClusterRoleBinding

+
+

ConfigMap#

+

Re-exports: ConfigMap

+
+

CronJob#

+

Re-exports: CronJob

+
+

CustomResourceDefinition#

+

Re-exports: CustomResourceDefinition

+
+

DaemonSet#

+

Re-exports: DaemonSet

+
+

Deployment#

+

Re-exports: Deployment

+
+

DeploymentApi#

+

Re-exports: DeploymentApi

+
+

Endpoint#

+

Re-exports: Endpoint

+
+

HorizontalPodAutoscaler#

+

Re-exports: HorizontalPodAutoscaler

+
+

IKubeApiCluster#

+

Re-exports: IKubeApiCluster

+
+

IPodContainer#

+

Re-exports: IPodContainer

+
+

IPodContainerStatus#

+

Re-exports: IPodContainerStatus

+
+

ISecretRef#

+

Re-exports: ISecretRef

+
+

Ingress#

+

Re-exports: Ingress

+
+

IngressApi#

+

Re-exports: IngressApi

+
+

Job#

+

Re-exports: Job

+
+

KubeApi#

+

Re-exports: KubeApi

+
+

KubeEvent#

+

Re-exports: KubeEvent

+
+

KubeObject#

+

Re-exports: KubeObject

+
+

KubeObjectStore#

+

Re-exports: KubeObjectStore

+
+

LimitRange#

+

Re-exports: LimitRange

+
+

Namespace#

+

Re-exports: Namespace

+
+

NetworkPolicy#

+

Re-exports: NetworkPolicy

+
+

Node#

+

Re-exports: Node

+
+

NodesApi#

+

Re-exports: NodesApi

+
+

PersistentVolume#

+

Re-exports: PersistentVolume

+
+

PersistentVolumeClaim#

+

Re-exports: PersistentVolumeClaim

+
+

PersistentVolumeClaimsApi#

+

Re-exports: PersistentVolumeClaimsApi

+
+

Pod#

+

Re-exports: Pod

+
+

PodDisruptionBudget#

+

Re-exports: PodDisruptionBudget

+
+

PodsApi#

+

Re-exports: PodsApi

+
+

ReplicaSet#

+

Re-exports: ReplicaSet

+
+

ResourceQuota#

+

Re-exports: ResourceQuota

+
+

ResourceStack#

+

Re-exports: ResourceStack

+
+

Role#

+

Re-exports: Role

+
+

RoleBinding#

+

Re-exports: RoleBinding

+
+

Secret#

+

Re-exports: Secret

+
+

Service#

+

Re-exports: Service

+
+

ServiceAccount#

+

Re-exports: ServiceAccount

+
+

StatefulSet#

+

Re-exports: StatefulSet

+
+

StorageClass#

+

Re-exports: StorageClass

+
+

apiManager#

+

Re-exports: apiManager

+
+

clusterRoleApi#

+

Re-exports: clusterRoleApi

+
+

clusterRoleBindingApi#

+

Re-exports: clusterRoleBindingApi

+
+

configMapApi#

+

Re-exports: configMapApi

+
+

crdApi#

+

Re-exports: crdApi

+
+

cronJobApi#

+

Re-exports: cronJobApi

+
+

daemonSetApi#

+

Re-exports: daemonSetApi

+
+

deploymentApi#

+

Re-exports: deploymentApi

+
+

endpointApi#

+

Re-exports: endpointApi

+
+

eventApi#

+

Re-exports: eventApi

+
+

forCluster#

+

Re-exports: forCluster

+
+

hpaApi#

+

Re-exports: hpaApi

+
+

ingressApi#

+

Re-exports: ingressApi

+
+

isAllowedResource#

+

Re-exports: isAllowedResource

+
+

jobApi#

+

Re-exports: jobApi

+
+

limitRangeApi#

+

Re-exports: limitRangeApi

+
+

namespacesApi#

+

Re-exports: namespacesApi

+
+

networkPolicyApi#

+

Re-exports: networkPolicyApi

+
+

nodesApi#

+

Re-exports: nodesApi

+
+

pdbApi#

+

Re-exports: pdbApi

+
+

persistentVolumeApi#

+

Re-exports: persistentVolumeApi

+
+

podsApi#

+

Re-exports: podsApi

+
+

pvcApi#

+

Re-exports: pvcApi

+
+

replicaSetApi#

+

Re-exports: replicaSetApi

+
+

resourceQuotaApi#

+

Re-exports: resourceQuotaApi

+
+

roleApi#

+

Re-exports: roleApi

+
+

roleBindingApi#

+

Re-exports: roleBindingApi

+
+

secretsApi#

+

Re-exports: secretsApi

+
+

serviceAccountsApi#

+

Re-exports: serviceAccountsApi

+
+

serviceApi#

+

Re-exports: serviceApi

+
+

statefulSetApi#

+

Re-exports: statefulSetApi

+
+

storageClassApi#

+

Re-exports: storageClassApi

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/main.navigation/index.html b/v5.2.6/extensions/api/modules/main.navigation/index.html new file mode 100644 index 0000000000..67bbd3b98d --- /dev/null +++ b/v5.2.6/extensions/api/modules/main.navigation/index.html @@ -0,0 +1,853 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Navigation - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Navigation#

+

Main.Navigation

+

Table of contents#

+

Functions#

+ +

Functions#

+ +

▸ navigate(url): Promise<void>

+

Parameters#

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

Returns#

+

Promise<void>

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/main/index.html b/v5.2.6/extensions/api/modules/main/index.html new file mode 100644 index 0000000000..03288efd7d --- /dev/null +++ b/v5.2.6/extensions/api/modules/main/index.html @@ -0,0 +1,826 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Main - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer.catalog/index.html b/v5.2.6/extensions/api/modules/renderer.catalog/index.html new file mode 100644 index 0000000000..ca4b46cd83 --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer.catalog/index.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Catalog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer.component/index.html b/v5.2.6/extensions/api/modules/renderer.component/index.html new file mode 100644 index 0000000000..3ae20e396c --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer.component/index.html @@ -0,0 +1,1724 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Component - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Component#

+

Renderer.Component

+

Table of contents#

+

Enumerations#

+ +

Classes#

+ +

Interfaces#

+ +

Type aliases#

+ +

Variables#

+ +

Functions#

+ +

Type aliases#

+

IconData#

+

Ƭ IconData: string | React.ReactNode | (opt: IconDataFnArg) => React.ReactNode

+

One of the folloing: +- A material icon name +- A react node +- Or a function that produces a react node

+
+

InputProps#

+

Ƭ InputProps: Omit<InputElementProps, "onChange" | "onSubmit"> & { autoSelectOnFocus?: boolean ; className?: string ; contentRight?: string | React.ReactNode ; defaultValue?: string ; dirty?: boolean ; iconLeft?: IconData ; iconRight?: IconData ; maxRows?: number ; multiLine?: boolean ; showErrorsAsTooltip?: boolean | Omit<TooltipProps, "targetId"> ; showValidationLine?: boolean ; theme?: "round-black" | "round" ; trim?: boolean ; validators?: InputValidator | InputValidator[] ; value?: string ; onChange?: (value: string, evt: ChangeEvent) => void ; onSubmit?: (value: string, evt: KeyboardEvent) => void }

+
+ +

Ƭ MenuContextValue: Menu

+
+

NotificationId#

+

Ƭ NotificationId: string | number

+
+

NotificationMessage#

+

Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

+
+

RadioProps#

+

Ƭ RadioProps: React.HTMLProps<any> & { checked?: boolean ; disabled?: boolean ; label?: React.ReactNode | any ; name?: string ; value?: any ; onChange?: (value: ChangeEvent) => void }

+
+

TableCellElem#

+

Ƭ TableCellElem: React.ReactElement<TableCellProps>

+
+

TableHeadElem#

+

Ƭ TableHeadElem: React.ReactElement<TableHeadProps>

+
+

TableOrderBy#

+

Ƭ TableOrderBy: "asc" | "desc" | string

+
+

TableRowElem#

+

Ƭ TableRowElem: React.ReactElement<TableRowProps>

+
+

TableSortBy#

+

Ƭ TableSortBy: string

+
+

TableSortCallback#

+

Ƭ TableSortCallback: (data: Item) => string | number | (string | number)[]

+

Type parameters#

+ + + + + + + + + + + +
Name
Item
+

Type declaration#

+

▸ (data): string | number | (string | number)[]

+
Parameters#
+ + + + + + + + + + + + + +
NameType
dataItem
+
Returns#
+

string | number | (string | number)[]

+
+

TableSortCallbacks#

+

Ƭ TableSortCallbacks<Item>: Record<string, TableSortCallback<Item>>

+

Type parameters#

+ + + + + + + + + + + +
Name
Item
+
+

TableSortParams#

+

Ƭ TableSortParams: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
orderByTableOrderBy
sortByTableSortBy
+

Variables#

+

InputValidators#

+

• InputValidators: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
accountIdInputValidator
isEmailInputValidator
isExtensionNameInstallInputValidator
isExtensionNameInstallRegexRegExp
isNumberInputValidator
isPathInputValidator
isRequiredInputValidator
isUrlInputValidator
maxLengthInputValidator
minLengthInputValidator
systemNameInputValidator
+
+ +

• Const MenuContext: Context<Menu>

+
+

Switcher#

+

• Const Switcher: ComponentType<Pick<Props, "name" | "prefix" | "defaultValue" | "id" | "title" | "className" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "style" | "hidden" | "autoFocus" | "disabled" | "form" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "type" | "value" | "defaultChecked" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "lang" | "placeholder" | "slot" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "action" | "checked" | "readOnly" | "required" | "size" | "ref" | "key" | "innerRef" | "icon" | "checkedIcon" | "disableFocusRipple" | "edge" | "buttonRef" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "onFocusVisible" | "TouchRippleProps" | "inputProps" | "inputRef"> & StyledComponentProps<"checked" | "track" | "root" | "thumb" | "focusVisible" | "switchBase">>

+
+

cpuOptions#

+

• Const cpuOptions: ChartOptions

+
+

kubeDetailsUrlParam#

+

• Const kubeDetailsUrlParam: PageParam<string>

+

Used to store object.selfLink to show more info about resource in the details panel.

+
+

kubeSelectedUrlParam#

+

• Const kubeSelectedUrlParam: PageParam<string>

+

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).

+
+

logTabStore#

+

• Const logTabStore: LogTabStore

+
+

memoryOptions#

+

• Const memoryOptions: ChartOptions

+
+

notificationsStore#

+

• Const notificationsStore: NotificationsStore

+
+

orderByUrlParam#

+

• Const orderByUrlParam: PageParam<string>

+
+

sortByUrlParam#

+

• Const sortByUrlParam: PageParam<string>

+
+

terminalStore#

+

• Const terminalStore: TerminalStore

+

deprecated use TerminalStore.getInstance() instead

+

Functions#

+

DrawerItemLabels#

+

▸ DrawerItemLabels(props): Element

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsDrawerItemLabelsProps
+

Returns#

+

Element

+
+

FormSwitch#

+

▸ FormSwitch(props): Element

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsFormControlLabelProps
+

Returns#

+

Element

+
+ +

▸ SubMenu(props): Element

+

Parameters#

+ + + + + + + + + + + + + +
NameType
propsPartial<MenuProps>
+

Returns#

+

Element

+
+

TabLayout#

+

▸ Const TabLayout(__namedParameters): Element

+

Parameters#

+ + + + + + + + + + + + + +
NameType
__namedParametersTabLayoutProps
+

Returns#

+

Element

+
+

createTerminalTab#

+

▸ createTerminalTab(tabParams?): Required<DockTabCreate>

+

Parameters#

+ + + + + + + + + + + + + +
NameType
tabParamsDockTabCreateSpecific
+

Returns#

+

Required<DockTabCreate>

+
+

getDetailsUrl#

+

▸ getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
selfLinkstringundefined
resetSelectedbooleanfalse
mergeGlobalsbooleantrue
+

Returns#

+

string

+
+

hideDetails#

+

▸ hideDetails(): void

+

Returns#

+

void

+
+

showDetails#

+

▸ showDetails(selfLink?, resetSelected?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
selfLinkstring""
resetSelectedbooleantrue
+

Returns#

+

void

+
+

toggleDetails#

+

▸ toggleDetails(selfLink, resetSelected?): void

+

Parameters#

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
selfLinkstringundefined
resetSelectedbooleantrue
+

Returns#

+

void

+
+

withTooltip#

+

▸ withTooltip<T>(Target): T

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: ComponentType<any>
+

Parameters#

+ + + + + + + + + + + + + +
NameType
TargetT
+

Returns#

+

T

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer.k8sapi/index.html b/v5.2.6/extensions/api/modules/renderer.k8sapi/index.html new file mode 100644 index 0000000000..cbb68247d6 --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer.k8sapi/index.html @@ -0,0 +1,1432 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: K8sApi - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: K8sApi#

+

Renderer.K8sApi

+

Table of contents#

+

Enumerations#

+ +

Classes#

+ +

Interfaces#

+ +

Type aliases#

+ +

Variables#

+ +

Functions#

+ +

Type aliases#

+

KubeObjectStatus#

+

Ƭ KubeObjectStatus: Object

+

Copyright (c) 2021 OpenLens Authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + +
NameType
levelKubeObjectStatusLevel
textstring
timestamp?string
+

Variables#

+

apiManager#

+

• Const apiManager: ApiManager

+
+

clusterRoleApi#

+

• Let clusterRoleApi: KubeApi<ClusterRole>

+

Only available within kubernetes cluster pages

+
+

clusterRoleBindingApi#

+

• Let clusterRoleBindingApi: KubeApi<ClusterRoleBinding>

+

Only available within kubernetes cluster pages

+
+

configMapApi#

+

• Let configMapApi: KubeApi<ConfigMap>

+

Only available within kubernetes cluster pages

+
+

crdApi#

+

• Let crdApi: KubeApi<CustomResourceDefinition>

+

Only available within kubernetes cluster pages

+
+

cronJobApi#

+

• Let cronJobApi: CronJobApi

+

Only available within kubernetes cluster pages

+
+

daemonSetApi#

+

• Let daemonSetApi: DaemonSetApi

+

Only available within kubernetes cluster pages

+
+

deploymentApi#

+

• Let deploymentApi: DeploymentApi

+
+

endpointApi#

+

• Let endpointApi: KubeApi<Endpoint>

+
+

eventApi#

+

• Let eventApi: KubeApi<KubeEvent>

+
+

hpaApi#

+

• Let hpaApi: KubeApi<HorizontalPodAutoscaler>

+
+

ingressApi#

+

• Let ingressApi: IngressApi

+
+

jobApi#

+

• Let jobApi: JobApi

+
+

limitRangeApi#

+

• Let limitRangeApi: KubeApi<LimitRange>

+
+

namespacesApi#

+

• Let namespacesApi: NamespaceApi

+
+

networkPolicyApi#

+

• Let networkPolicyApi: KubeApi<NetworkPolicy>

+
+

nodesApi#

+

• Let nodesApi: NodesApi

+
+

pdbApi#

+

• Let pdbApi: KubeApi<PodDisruptionBudget>

+
+

persistentVolumeApi#

+

• Let persistentVolumeApi: KubeApi<PersistentVolume>

+
+

podsApi#

+

• Let podsApi: PodsApi

+
+

pvcApi#

+

• Let pvcApi: PersistentVolumeClaimsApi

+
+

replicaSetApi#

+

• Let replicaSetApi: ReplicaSetApi

+
+

resourceQuotaApi#

+

• Let resourceQuotaApi: KubeApi<ResourceQuota>

+
+

roleApi#

+

• Let roleApi: KubeApi<Role>

+
+

roleBindingApi#

+

• Let roleBindingApi: KubeApi<RoleBinding>

+
+

secretsApi#

+

• Let secretsApi: KubeApi<Secret>

+
+

serviceAccountsApi#

+

• Let serviceAccountsApi: KubeApi<ServiceAccount>

+
+

serviceApi#

+

• Let serviceApi: KubeApi<Service>

+
+

statefulSetApi#

+

• Let statefulSetApi: StatefulSetApi

+
+

storageClassApi#

+

• Let storageClassApi: KubeApi<StorageClass>

+

Functions#

+

forCluster#

+

▸ forCluster<T>(cluster, kubeClass): KubeApi<T>

+

Type parameters#

+ + + + + + + + + + + + + +
NameType
TT: KubeObject<KubeObjectMetadata, any, any, T>
+

Parameters#

+ + + + + + + + + + + + + + + + + +
NameType
clusterIKubeApiCluster
kubeClassKubeObjectConstructor<T>
+

Returns#

+

KubeApi<T>

+
+

isAllowedResource#

+

▸ isAllowedResource(resource): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
resourceKubeResource | KubeResource[]
+

Returns#

+

boolean

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer.navigation/index.html b/v5.2.6/extensions/api/modules/renderer.navigation/index.html new file mode 100644 index 0000000000..2fa57d9631 --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer.navigation/index.html @@ -0,0 +1,1001 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Navigation - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Navigation#

+

Renderer.Navigation

+

Table of contents#

+

References#

+ +

Classes#

+ +

Interfaces#

+ +

Functions#

+ +

References#

+

getDetailsUrl#

+

Re-exports: getDetailsUrl

+
+

hideDetails#

+

Re-exports: hideDetails

+
+

showDetails#

+

Re-exports: showDetails

+

Functions#

+

createPageParam#

+

▸ createPageParam<V>(init): PageParam<V>

+

Type parameters#

+ + + + + + + + + + + +
Name
V
+

Parameters#

+ + + + + + + + + + + + + +
NameType
initPageParamInit<V>
+

Returns#

+

PageParam<V>

+
+

isActiveRoute#

+

▸ isActiveRoute(route): boolean

+

Parameters#

+ + + + + + + + + + + + + +
NameType
routestring | string[] | RouteProps
+

Returns#

+

boolean

+
+ +

▸ navigate(location): void

+

Parameters#

+ + + + + + + + + + + + + +
NameType
locationLocationDescriptor
+

Returns#

+

void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer.theme/index.html b/v5.2.6/extensions/api/modules/renderer.theme/index.html new file mode 100644 index 0000000000..2acf1cce1c --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer.theme/index.html @@ -0,0 +1,838 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Theme - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Namespace: Theme#

+

Renderer.Theme

+

Table of contents#

+

Functions#

+ +

Functions#

+

getActiveTheme#

+

▸ getActiveTheme(): Theme

+

Returns#

+

Theme

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/api/modules/renderer/index.html b/v5.2.6/extensions/api/modules/renderer/index.html new file mode 100644 index 0000000000..88e8a510eb --- /dev/null +++ b/v5.2.6/extensions/api/modules/renderer/index.html @@ -0,0 +1,828 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Namespace: Renderer - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/capabilities/common-capabilities/index.html b/v5.2.6/extensions/capabilities/common-capabilities/index.html new file mode 100644 index 0000000000..77665422f7 --- /dev/null +++ b/v5.2.6/extensions/capabilities/common-capabilities/index.html @@ -0,0 +1,1341 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Common Capabilities - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 { Main } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends Main.LensExtension {
+  async onActivate() {
+    console.log("hello world")
+  }
+}
+
+

Deactivate#

+

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

+
import { Main } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends Main.LensExtension {
+  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 { Main } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends Main.LensExtension {
+  appMenus = [
+    {
+      parentId: "help",
+      label: "Example item",
+      click() {
+        Main.Navigation.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 { Renderer } from "@k8slens/extensions"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  async onActivate() {
+    console.log("hello world")
+  }
+}
+
+

Deactivate#

+

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

+
import { Renderer } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends Renderer.LensExtension {
+  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 { Renderer } from "@k8slens/extensions"
+import { ExamplePage } from "./src/example-page"
+
+const {
+  Component: {
+    Icon,
+  }
+} = Renderer;
+
+export default class ExampleRendererExtension extends Renderer.LensExtension {
+  globalPages = [
+    {
+      id: "example",
+      components: {
+        Page: ExamplePage,
+      }
+    }
+  ]
+
+  globalPageMenus = [
+    {
+      title: "Example page", // used in icon's tooltip
+      target: { pageId: "example" }
+      components: {
+        Icon: () => <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 { Renderer } from "@k8slens/extensions"
+import { myCustomPreferencesStore } from "./src/my-custom-preferences-store"
+import { MyCustomPreferenceHint, MyCustomPreferenceInput } from "./src/my-custom-preference"
+
+
+export default class ExampleRendererExtension extends Renderer.LensExtension {
+  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 { Renderer } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./src/page"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  clusterPages = [
+    {
+      id: "extension-example", // optional
+      exact: true, // optional
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    }
+  ]
+
+  clusterPageMenus = [
+    {
+      url: "/extension-example", // optional
+      title: "Example Extension",
+      components: {
+        Icon: ExampleIcon,
+      }
+    }
+  ]
+}
+
+

Top Bar Items#

+

This extension can register custom components to a top bar area.

+
import React from "react";
+import { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    Icon,
+  }
+} = Renderer;
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  topBarItems = [
+    {
+      components: {
+        Item: (
+          <Icon material="favorite" onClick={() => this.navigate("/example-page" />
+        )
+      }
+    }
+  ]
+}
+
+

Status Bar Items#

+

This extension can register custom icons and text to a status bar area.

+
import React from "react";
+import { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    Icon,
+  }
+} = Renderer;
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  statusBarItems = [
+    {
+      components: {
+        Item: (
+          <div className="flex align-center gaps hover-highlight" onClick={() => this.navigate("/example-page")} >
+            <Icon material="favorite" />
+          </div>
+        )
+      }
+    }
+  ]
+}
+
+

Kubernetes Workloads Overview Items#

+

This extension can register custom workloads overview items.

+
import React from "react"
+import { Renderer } from "@k8slens/extensions";
+import { CustomWorkloadsOverviewItem } from "./src/custom-workloads-overview-item"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  kubeWorkloadsOverviewItems = [
+    {
+      components : {
+        Details: () => <CustomWorkloadsOverviewItem />
+      }
+    }
+  ]
+}
+
+

Kubernetes Object Menu Items#

+

This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

+
import React from "react"
+import { Renderer } from "@k8slens/extensions";
+import { CustomMenuItem, CustomMenuItemProps } from "./src/custom-menu-item"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  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 { Renderer } from "@k8slens/extensions";
+import { CustomKindDetails, CustomKindDetailsProps } from "./src/custom-kind-details"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  kubeObjectDetailItems = [
+    {
+      kind: "CustomKind",
+      apiVersions: ["custom.acme.org/v1"],
+      components: {
+        Details: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />
+      }
+    }
+  ]
+}
+
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/capabilities/images/css-vars-in-devtools.png b/v5.2.6/extensions/capabilities/images/css-vars-in-devtools.png new file mode 100644 index 0000000000..a9df97e6bb Binary files /dev/null and b/v5.2.6/extensions/capabilities/images/css-vars-in-devtools.png differ diff --git a/v5.2.6/extensions/capabilities/images/theme-selector.png b/v5.2.6/extensions/capabilities/images/theme-selector.png new file mode 100644 index 0000000000..5c2eba3165 Binary files /dev/null and b/v5.2.6/extensions/capabilities/images/theme-selector.png differ diff --git a/v5.2.6/extensions/capabilities/index.html b/v5.2.6/extensions/capabilities/index.html new file mode 100644 index 0000000000..1f322c3c8e --- /dev/null +++ b/v5.2.6/extensions/capabilities/index.html @@ -0,0 +1,759 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Index - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ + + + +

Index

+ + + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/capabilities/styling/index.html b/v5.2.6/extensions/capabilities/styling/index.html new file mode 100644 index 0000000000..b75cab57b7 --- /dev/null +++ b/v5.2.6/extensions/capabilities/styling/index.html @@ -0,0 +1,1111 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Styling - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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);
+}
+
+

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 { Renderer } from "@k8slens/extensions";
+
+@observer
+export class SupportPage extends React.Component {
+  render() {
+    return (
+      <div className="SupportPage">
+        <h1>Active theme is {Renderer.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/v5.2.6/extensions/extension-migration/index.html b/v5.2.6/extensions/extension-migration/index.html new file mode 100644 index 0000000000..6c4a2463ec --- /dev/null +++ b/v5.2.6/extensions/extension-migration/index.html @@ -0,0 +1,801 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Lens v4 to v5 Extension Migration Notes - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Lens v4 to v5 Extension Migration Notes#

+
    +
  • Lens v5 inspects the version of the extension to ensure it is compatible. +The package.json for your extension must have an "engines" field specifying the lens version that your extension is targeted for, e.g: +
        "engines": {
+        "lens": "^5.0.0-beta.7"
+    },
+
    +Note that Lens v5 supports all the range semantics that semver provides.
    • +
  • Types and components have been reorganized, many have been grouped by process (Main and Renderer) plus those not specific to a process (Common). +For example the LensMainExtension class is now referred to by Main.LensExtension. +See the API Reference for the new organization.
    • +
  • The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension) is removed. +Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.
    • +
  • The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension) is removed. +Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. +Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. +It is up to the extension developer to manage the lifecycle. +It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page.
    • +
  • Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. +See Migrating from Mobx 4/5 for specific details.
    • +
+

For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/get-started/anatomy/index.html b/v5.2.6/extensions/get-started/anatomy/index.html new file mode 100644 index 0000000000..ab0bbed15c --- /dev/null +++ b/v5.2.6/extensions/get-started/anatomy/index.html @@ -0,0 +1,1010 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Extension Anatomy - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 onDeactivate() 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 { Renderer } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  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/v5.2.6/extensions/get-started/overview/index.html b/v5.2.6/extensions/get-started/overview/index.html new file mode 100644 index 0000000000..efa5456308 --- /dev/null +++ b/v5.2.6/extensions/get-started/overview/index.html @@ -0,0 +1,906 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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/v5.2.6/extensions/get-started/wrapping-up/index.html b/v5.2.6/extensions/get-started/wrapping-up/index.html new file mode 100644 index 0000000000..18729e3043 --- /dev/null +++ b/v5.2.6/extensions/get-started/wrapping-up/index.html @@ -0,0 +1,916 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Wrapping Up - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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/v5.2.6/extensions/get-started/your-first-extension/index.html b/v5.2.6/extensions/get-started/your-first-extension/index.html new file mode 100644 index 0000000000..b913255586 --- /dev/null +++ b/v5.2.6/extensions/get-started/your-first-extension/index.html @@ -0,0 +1,1028 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Your First Extension - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. +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/v5.2.6/extensions/guides/anatomy/index.html b/v5.2.6/extensions/guides/anatomy/index.html new file mode 100644 index 0000000000..732b5dfe61 --- /dev/null +++ b/v5.2.6/extensions/guides/anatomy/index.html @@ -0,0 +1,795 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Anatomy - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Anatomy

+ +
+

WIP#

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/catalog/index.html b/v5.2.6/extensions/guides/catalog/index.html new file mode 100644 index 0000000000..a7e44def37 --- /dev/null +++ b/v5.2.6/extensions/guides/catalog/index.html @@ -0,0 +1,887 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Catalog - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Catalog (WIP)#

+

CatalogCategoryRegistry#

+

CatalogEntityRegistry#

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/components/index.html b/v5.2.6/extensions/guides/components/index.html new file mode 100644 index 0000000000..483fe11b20 --- /dev/null +++ b/v5.2.6/extensions/guides/components/index.html @@ -0,0 +1,795 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Components - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Components

+ +
+

WIP#

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/generator/index.html b/v5.2.6/extensions/guides/generator/index.html new file mode 100644 index 0000000000..90ccf618b3 --- /dev/null +++ b/v5.2.6/extensions/guides/generator/index.html @@ -0,0 +1,960 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Generator - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 latest Lens contribution guidelines here.

+

The Generator source code is hosted at GitHub.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/images/certificates-crd-list.png b/v5.2.6/extensions/guides/images/certificates-crd-list.png new file mode 100644 index 0000000000..19c9558f71 Binary files /dev/null and b/v5.2.6/extensions/guides/images/certificates-crd-list.png differ diff --git a/v5.2.6/extensions/guides/images/clusterfeature.png b/v5.2.6/extensions/guides/images/clusterfeature.png new file mode 100644 index 0000000000..ada8beba6f Binary files /dev/null and b/v5.2.6/extensions/guides/images/clusterfeature.png differ diff --git a/v5.2.6/extensions/guides/images/clusterpagemenus.png b/v5.2.6/extensions/guides/images/clusterpagemenus.png new file mode 100644 index 0000000000..77a3ec118a Binary files /dev/null and b/v5.2.6/extensions/guides/images/clusterpagemenus.png differ diff --git a/v5.2.6/extensions/guides/images/globalpagemenus.png b/v5.2.6/extensions/guides/images/globalpagemenus.png new file mode 100644 index 0000000000..e986cc32e9 Binary files /dev/null and b/v5.2.6/extensions/guides/images/globalpagemenus.png differ diff --git a/v5.2.6/extensions/guides/images/hello-lens.png b/v5.2.6/extensions/guides/images/hello-lens.png new file mode 100644 index 0000000000..5e2c0ac0a5 Binary files /dev/null and b/v5.2.6/extensions/guides/images/hello-lens.png differ diff --git a/v5.2.6/extensions/guides/images/hello-world.png b/v5.2.6/extensions/guides/images/hello-world.png new file mode 100644 index 0000000000..1a4a9c73a9 Binary files /dev/null and b/v5.2.6/extensions/guides/images/hello-world.png differ diff --git a/v5.2.6/extensions/guides/images/kubeobjectdetailitem.png b/v5.2.6/extensions/guides/images/kubeobjectdetailitem.png new file mode 100644 index 0000000000..e2d68f0c3b Binary files /dev/null and b/v5.2.6/extensions/guides/images/kubeobjectdetailitem.png differ diff --git a/v5.2.6/extensions/guides/images/kubeobjectdetailitemwithpods.png b/v5.2.6/extensions/guides/images/kubeobjectdetailitemwithpods.png new file mode 100644 index 0000000000..9a91f230f3 Binary files /dev/null and b/v5.2.6/extensions/guides/images/kubeobjectdetailitemwithpods.png differ diff --git a/v5.2.6/extensions/guides/images/kubeobjectmenuitem.png b/v5.2.6/extensions/guides/images/kubeobjectmenuitem.png new file mode 100644 index 0000000000..f9f91675de Binary files /dev/null and b/v5.2.6/extensions/guides/images/kubeobjectmenuitem.png differ diff --git a/v5.2.6/extensions/guides/images/kubeobjectmenuitemdetail.png b/v5.2.6/extensions/guides/images/kubeobjectmenuitemdetail.png new file mode 100644 index 0000000000..ab5f9ac0f0 Binary files /dev/null and b/v5.2.6/extensions/guides/images/kubeobjectmenuitemdetail.png differ diff --git a/v5.2.6/extensions/guides/images/routing-diag.png b/v5.2.6/extensions/guides/images/routing-diag.png new file mode 100644 index 0000000000..9185ce94d8 Binary files /dev/null and b/v5.2.6/extensions/guides/images/routing-diag.png differ diff --git a/v5.2.6/extensions/guides/index.html b/v5.2.6/extensions/guides/index.html new file mode 100644 index 0000000000..c7ea37faac --- /dev/null +++ b/v5.2.6/extensions/guides/index.html @@ -0,0 +1,978 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 extensionMain.LensExtension
Renderer process extensionRenderer.LensExtension
Resource stack (cluster feature)
Stores
Components
KubeObjectListLayout
Working with mobx
Protocol Handlers
Sending Data between main and renderer
+

Samples#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SampleAPIs
hello-worldLensMainExtension
LensRendererExtension
Renderer.Component.Icon
Renderer.Component.IconProps
styling-css-modules-sampleLensMainExtension
LensRendererExtension
Renderer.Component.Icon
Renderer.Component.IconProps
styling-emotion-sampleLensMainExtension
LensRendererExtension
Renderer.Component.Icon
Renderer.Component.IconProps
styling-sass-sampleLensMainExtension
LensRendererExtension
Renderer.Component.Icon
Renderer.Component.IconProps
custom-resource-pageLensRendererExtension
Renderer.K8sApi.KubeApi
Renderer.K8sApi.KubeObjectStore
Renderer.Component.KubeObjectListLayout
Renderer.Component.KubeObjectDetailsProps
Renderer.Component.IconProps
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/ipc/index.html b/v5.2.6/extensions/guides/ipc/index.html new file mode 100644 index 0000000000..e36c87da3e --- /dev/null +++ b/v5.2.6/extensions/guides/ipc/index.html @@ -0,0 +1,1060 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + IPC - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Inter Process Communication#

+

A Lens Extension can utilize IPC to send information between the renderer and main processes. +This is useful when wanting to communicate directly within your extension.

+

For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog, this would be a good way to send that information along.

+

IPC channels are sectioned off per extension. +Meaning that each extension can only communicate with itself.

+

Types of Communication#

+

There are two flavours of communication that are provided:

+
    +
  • Event based (IPC)
    • +
  • Request based (RPC)
    • +
+

Event Based or IPC#

+

This is the same as an Event Emitter but is not limited to just one Javascript process. +This is a good option when you need to report that something has happened but you don't need a response.

+

This is a fully two-way form of communication. +Both main and renderer can do this sort of IPC.

+

Request Based or RPC#

+

This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). +With this sort of communication the caller needs to wait for the result from the other side. +This is accomplished by await-ing the returned Promise<any>.

+

This is a unidirectional form of communication. +Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request.

+

Registering IPC Handlers and Listeners#

+

The general terminology is as follows:

+
    +
  • A "handler" is the function that responds to a "Request Based IPC" event.
    • +
  • A "listener" is the function that is called when a "Event Based IPC" event is emitted.
    • +
+

To register either a handler or a listener, you should do something like the following:

+

main.ts: +

import { Main } from "@k8slens/extensions";
+import { IpcMain } from "./helpers/main";
+
+export class ExampleExtensionMain extends Main.LensExtension {
+  onActivate() {
+    IpcMain.createInstance(this);
+  }
+}
+

+

This file shows that you need to create an instance of the store to be able to use IPC. +Lens will automatically clean up that store and all the handlers on deactivation and uninstall.

+
+

helpers/main.ts: +

import { Main } from "@k8slens/extensions";
+
+export class IpcMain extends Main.Ipc {
+  constructor(extension: Main.LensExtension) {
+    super(extension);
+
+    this.listen("initialize", onInitialize);
+  }
+}
+
+function onInitialize(event: Types.IpcMainEvent, id: string) {
+  console.log(`starting to initialize: ${id}`);
+}
+

+

In other files, it is not necessary to pass around any instances. +You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension.

+
+

renderer.ts: +

import { Renderer } from "@k8slens/extensions";
+import { IpcRenderer } from "./helpers/renderer";
+
+export class ExampleExtensionRenderer extends Renderer.LensExtension {
+  onActivate() {
+    const ipc = IpcRenderer.createInstance(this);
+
+    setTimeout(() => ipc.broadcast("initialize", "an-id"), 5000);
+  }
+}
+

+

It is also needed to create an instance to broadcast messages too.

+
+

helpers/renderer.ts: +

import { Renderer } from "@k8slens/extensions";
+
+export class IpcRenderer extends Renderer.Ipc {}
+

+

It is necessary to create child classes of these abstract class's in your extension before you can use them.

+
+

As this example shows: the channel names must be the same. +It should also be noted that "listeners" and "handlers" are specific to either renderer or main. +There is no behind the scenes transfer of these functions.

+

To register a "handler" call IpcMain.getInstance().handle(...). +The cleanup of these handlers is handled by Lens itself.

+

The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer, or more specifically, a () => void. +This can be optionally called to remove the listener early.

+

Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main. +Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified.

+

Allowed Values#

+

This IPC mechanism utilizes the Structured Clone Algorithm for serialization. +This means that more types than what are JSON serializable can be used, but not all the information will be passed through.

+

Using Request Based Communication#

+

If you are meaning to do a request based call from renderer, you should do const res = await IpcRenderer.getInstance().invoke(<channel>, ...<args>)); instead.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/kube-object-list-layout/index.html b/v5.2.6/extensions/guides/kube-object-list-layout/index.html new file mode 100644 index 0000000000..7097350af8 --- /dev/null +++ b/v5.2.6/extensions/guides/kube-object-list-layout/index.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + KubeObjectListLayout Sample - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 Renderer.LensExtension {
+}
+
+

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.

+
import { Renderer } from "@k8slens/extensions";
+
+type IconProps = Renderer.Component.IconProps;
+
+const {
+  Component: {
+    Icon,
+  },
+} = Renderer;
+
+export function CertificateIcon(props: IconProps) {
+  return <Icon {...props} material="security" tooltip="Certificates"/>
+}
+
+export default class CrdSampleExtension extends Renderer.LensExtension {
+
+  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 Renderer.LensExtension {
+  ...
+
+  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 Renderer.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 Renderer.K8sApi.KubeObject, CertificatesApiderived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore.

+

Certificate class defines properties found in the CRD object:

+
import { Renderer } from "@k8slens/extensions";
+
+const {
+  K8sApi: {
+    KubeObject,
+    KubeObjectStore,
+    KubeApi,
+    apiManager,
+  },
+} = Renderer;
+
+export class Certificate extends 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 KubeApi<Certificate> {}
+
+export const certificatesApi = new CertificatesApi({
+  objectConstructor: Certificate
+});
+
+

CertificateStore defines storage for Certificate objects

+
export class CertificatesStore extends KubeObjectStore<Certificate> {
+  api = certificatesApi
+}
+
+export const certificatesStore = new CertificatesStore();
+
+

And, finally, we register this store to Lens's API manager.

+
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 { Renderer } from "@k8slens/extensions";
+import React from "react";
+import { certificatesStore } from "../certificate-store";
+import { Certificate } from "../certificate"
+
+export class CertificatePage extends React.Component<{ extension: Renderer.LensExtension }> {
+
+}
+
+

Next we will implement render method that will display certificates in a list. +To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. +To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. +Renderer.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:

+
import { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    TabLayout,
+    KubeObjectListLayout,
+  },
+} = Renderer;
+
+enum sortBy {
+  name = "name",
+  namespace = "namespace",
+  issuer = "issuer"
+}
+
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+  // ...
+
+  render() {
+    return (
+      <TabLayout>
+        <KubeObjectListLayout
+          className="Certificates" 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
+          ]}
+        />
+      </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 Renderer.LensExtension {
+  //...
+
+  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 Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

+
import { Renderer } from "@k8slens/extensions";
+import React from "react";
+import { Certificate } from "../certificate";
+
+const {
+  Component: {
+    KubeObjectDetailsProps,
+    DrawerItem,
+    Badge,
+  }
+} = Renderer;
+
+export interface CertificateDetailsProps extends KubeObjectDetailsProps<Certificate>{
+}
+
+export class CertificateDetails extends React.Component<CertificateDetailsProps> {
+
+  render() {
+    const { object: certificate } = this.props;
+    if (!certificate) return null;
+    return (
+      <div className="Certificate">
+        <DrawerItem name="Created">
+          {certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })
+        </DrawerItem>
+        <DrawerItem name="DNS Names">
+          {certificate.spec.dnsNames.join(",")}
+        </DrawerItem>
+        <DrawerItem name="Secret">
+          {certificate.spec.secretName}
+        </DrawerItem>
+        <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 (
+              <Badge
+                key={kind + index} label={kind}
+                className={"success "+kind.toLowerCase()}
+                tooltip={message}
+              />
+            );
+          })}
+        </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/v5.2.6/extensions/guides/main-extension/index.html b/v5.2.6/extensions/guides/main-extension/index.html new file mode 100644 index 0000000000..bd5bdc3b0c --- /dev/null +++ b/v5.2.6/extensions/guides/main-extension/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Main Extension - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 protocol handlers, and run custom code in Lens's main process. +It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.

+

Main.LensExtension Class#

+

onActivate() and onDeactivate() Methods#

+

To create a main extension simply extend the Main.LensExtension class:

+
import { Main } from "@k8slens/extensions";
+
+export default class ExampleExtensionMain extends Main.LensExtension {
+  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.

+

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 { Main } from "@k8slens/extensions";
+
+export default class SamplePageMainExtension extends Main.LensExtension {
+  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 Renderer.LensExtension class and can be defined in the process of extending it.
    • +
+

The following example demonstrates how an application menu can be used to navigate to such a page:

+
import { Main } from "@k8slens/extensions";
+
+export default class SamplePageMainExtension extends Main.LensExtension {
+  appMenus = [
+    {
+      parentId: "help",
+      label: "Sample",
+      click: () => this.navigate("myGlobalPage")
+    }
+  ]
+}
+
+

When the menu item is clicked the navigate() method looks for and displays a global page with id "myGlobalPage". +This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension).

+

addCatalogSource() and removeCatalogSource() Methods#

+

The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). +See the Catalog documentation for full details about the catalog.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/protocol-handlers/index.html b/v5.2.6/extensions/guides/protocol-handlers/index.html new file mode 100644 index 0000000000..9a390083df --- /dev/null +++ b/v5.2.6/extensions/guides/protocol-handlers/index.html @@ -0,0 +1,960 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Protocol Handlers - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 { Main, Common } from "@k8slens/extensions";
+
+function rootHandler(params: Common.Types.ProtocolRouteParams) {
+  console.log("routed to ExampleExtension", params);
+}
+
+export default class ExampleExtensionMain extends Main.LensExtension {
+  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/v5.2.6/extensions/guides/renderer-extension/index.html b/v5.2.6/extensions/guides/renderer-extension/index.html new file mode 100644 index 0000000000..2dc91747ab --- /dev/null +++ b/v5.2.6/extensions/guides/renderer-extension/index.html @@ -0,0 +1,1795 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Renderer Extension - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Renderer Extension (WIP)#

+

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, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process.

+

The custom Lens UI elements that you can add include:

+ +

as well as catalog-related UI elements:

+ +

All UI elements are based on React components.

+

Finally, you can also add commands and protocol handlers:

+ +

Renderer.LensExtension Class#

+

onActivate() and onDeactivate() Methods#

+

To create a renderer extension, extend the Renderer.LensExtension class:

+
import { Renderer } from "@k8slens/extensions";
+
+export default class ExampleExtensionMain extends Renderer.LensExtension {
+  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. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose 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.getInstance().

+

Add a cluster page definition to a Renderer.LensExtension subclass with the following example:

+
import { Renderer } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  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 { Renderer } 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, below Lens's standard cluster menus like Workloads, Custom Resources, etc.

+

By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition:

+
import { Renderer } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  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 { Renderer } from "@k8slens/extensions";
+import React from "react"
+
+type IconProps = Renderer.Component.IconProps;
+
+const {
+  Component: { Icon },
+} = Renderer;
+
+export function ExampleIcon(props: IconProps) {
+  return <Icon {...props} material="pages" tooltip={"Hi!"}/>
+}
+
+export class ExamplePage extends React.Component<{ extension: Renderer.LensExtension }> {
+  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 Renderer.Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. +The properties that Renderer.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 { Renderer } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  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 could look like, including how the menu item will appear in the secondary left nav:

+

Cluster Page Menus

+

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 (or catalog entities), including customized data and functionality unique to your extension.

+

Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity).

+

The following example defines a Renderer.LensExtension subclass with a single global page definition:

+
import { Renderer } from '@k8slens/extensions';
+import { HelpPage } from './page';
+import React from 'react';
+
+export default class HelpExtension extends Renderer.LensExtension {
+  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 { Renderer } 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 are typically 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 Welcome Page, see welcomeMenus.
    • +
+

welcomeMenus#

+

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 { Renderer } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { observable } from "mobx";
+import React from "react";
+
+export default class ExampleRendererExtension extends Renderer.LensExtension {
+
+  @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 { Renderer } from "@k8slens/extensions";
+import { makeObservable } from "mobx";
+import { observer } from "mobx-react";
+import React from "react";
+
+const {
+  Component: {
+    Checkbox,
+  },
+} = Renderer;
+
+export class ExamplePreferenceProps {
+  preference: {
+    enabled: boolean;
+  }
+}
+
+@observer
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+
+  public constructor() {
+    super({preference: { enabled: false}});
+    makeObservable(this);
+  }
+
+  render() {
+    const { preference } = this.props;
+    return (
+      <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 Renderer.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 makeObservable 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.

+

topBarItems#

+

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 { Renderer } from '@k8slens/extensions';
+import { HelpIcon, HelpPage } from "./page"
+import React from 'react';
+
+export default class HelpExtension extends Renderer.LensExtension {
+  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 { Renderer } from "@k8slens/extensions";
+import { NamespaceMenuItem } from "./src/namespace-menu-item"
+
+type KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;
+type Namespace = Renderer.K8sApi.Namespace;
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  kubeObjectMenuItems = [
+    {
+      kind: "Namespace",
+      apiVersions: ["v1"],
+      components: {
+        MenuItem: (props: KubeObjectMenuProps<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 { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    terminalStore,
+    MenuItem,
+    Icon,
+  },
+  Navigation,
+} = Renderer;
+
+type KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;
+type Namespace = Renderer.K8sApi.Namespace;
+
+export function NamespaceMenuItem(props: KubeObjectMenuProps<Namespace>) {
+  const { object: namespace, toolbar } = props;
+  if (!namespace) return null;
+
+  const namespaceName = namespace.getName();
+
+  const sendToTerminal = (command: string) => {
+    terminalStore.sendCommand(command, {
+      enter: true,
+      newTab: true,
+    });
+    Navigation.hideDetails();
+  };
+
+  const getPods = () => {
+    sendToTerminal(`kubectl get pods -n ${namespaceName}`);
+  };
+
+  return (
+    <MenuItem onClick={getPods}>
+      <Icon material="speaker_group" interactive={toolbar} title="Get pods in terminal"/>
+      <span className="title">Get Pods</span>
+    </MenuItem>
+  );
+}
+
+

NamespaceMenuItem returns a Renderer.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 Renderer.K8sApi.Namespace. +Renderer.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 { Renderer } from "@k8slens/extensions";
+import { NamespaceDetailsItem } from "./src/namespace-details-item";
+
+type KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;
+type KubeObjectDetailsProps = Renderer.Component.KubeObjectDetailsProps;
+type Namespace = Renderer.K8sApi.Namespace;
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  kubeObjectDetailItems = [
+    {
+      kind: "Namespace",
+      apiVersions: ["v1"],
+      priority: 10,
+      components: {
+        Details: (props: KubeObjectDetailsProps<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 { Renderer } from "@k8slens/extensions";
+import { PodsDetailsList } from "./pods-details-list";
+import React from "react";
+import { observable } from "mobx";
+import { observer } from "mobx-react";
+
+const {
+  K8sApi: {
+    podsApi,
+  },
+  Component: {
+    DrawerTitle,
+  },
+} = Renderer;
+
+type KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;
+type Namespace = Renderer.K8sApi.Namespace;
+type Pod = Renderer.K8sApi.Pod;
+
+@observer
+export class NamespaceDetailsItem extends React.Component<KubeObjectDetailsProps<Namespace>> {
+  @observable private pods: Pod[];
+
+  async componentDidMount() {
+    const namespace = this.props.object.getName();
+
+    this.pods = await podsApi.list({ namespace });
+  }
+
+  render() {
+    return (
+      <div>
+        <DrawerTitle title="Pods" />
+        <PodsDetailsList pods={this.pods}/>
+      </div>
+    )
+  }
+}
+
+

Since NamespaceDetailsItem extends React.Component<KubeObjectDetailsProps<Namespace>>, it can access the current namespace object (type 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 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 podsApi.list() method. +The podsApi is automatically configured for the active cluster.

+

Note that 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 Renderer.Component.DrawerTitle provides a separator from details above this one. +Multiple details in a drawer can be placed in <Renderer.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 { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    TableHead,
+    TableRow,
+    TableCell,
+    Table,
+  },
+} = Renderer;
+
+type Pod = Renderer.K8sApi.Pod;
+
+interface Props {
+  pods?: Pod[];
+}
+
+export class PodsDetailsList extends React.Component<Props> {
+  getTableRow = (pod: Pod) => {
+    return (
+      <TableRow key={index} nowrap>
+        <TableCell className="podName">{pods[index].getName()}</TableCell>
+        <TableCell className="podAge">{pods[index].getAge()}</TableCell>
+        <TableCell className="podStatus">{pods[index].getStatus()}</TableCell>
+      </TableRow>
+    )
+  };
+
+  render() {
+    const { pods } = this.props
+
+    if (!pods?.length) {
+      return null;
+    }
+
+    return (
+      <div>
+        <Table>
+          <TableHead>
+            <TableCell className="podName">Name</TableCell>
+            <TableCell className="podAge">Age</TableCell>
+            <TableCell className="podStatus">Status</TableCell>
+          </TableHead>
+          { pods.map(this.getTableRow) }
+        </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 Renderer.K8sApi.Pod methods. +Construct the table using the Renderer.Component.Table and related elements.

+

For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. +The table is constructed using the Renderer.Component.Table and related elements. +See Component documentation for further details.

+

kubeObjectStatusTexts#

+

kubeWorkloadsOverviewItems#

+

entitySettings#

+

catalogEntityDetailItems#

+

commandPaletteCommands#

+

protocolHandlers#

+

See the Protocol Handlers Guide

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/resource-stack/index.html b/v5.2.6/extensions/guides/resource-stack/index.html new file mode 100644 index 0000000000..db63d30d79 --- /dev/null +++ b/v5.2.6/extensions/guides/resource-stack/index.html @@ -0,0 +1,1040 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Resource Stack - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Resource Stack (Cluster Feature)#

+

A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. +The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. +It is up to the extension developer to manage the life cycle of the resource stack. +It could be applied automatically to a cluster by the extension, or the end-user could be required to install it.

+

The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable 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 resource stack in this example consists of a single kubernetes resource:

+
apiVersion: v1
+kind: Pod
+metadata:
+  name: example-pod
+spec:
+  containers:
+  - name: example-pod
+    image: nginx
+
+

It is simply a pod named example-pod, running nginx. Assume this content is in the file ../resources/example-pod.yml.

+

The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack:

+
import { Renderer, Common } from "@k8slens/extensions";
+import * as path from "path";
+
+const {
+  K8sApi: {
+    ResourceStack, 
+    forCluster, 
+    Pod,
+  }
+} = Renderer;
+
+type ResourceStack = Renderer.K8sApi.ResourceStack;
+type Pod = Renderer.K8sApi.Pod;
+type KubernetesCluster = Common.Catalog.KubernetesCluster;
+
+export class ExampleClusterFeature {
+  protected stack: ResourceStack;
+
+  constructor(protected cluster: KubernetesCluster) {
+    this.stack = new ResourceStack(cluster, "example-resource-stack");
+  }
+
+  get resourceFolder() {
+    return path.join(__dirname, "../resources/");
+  }
+
+  install(): Promise<string> {
+    console.log("installing example-pod");
+    return this.stack.kubectlApplyFolder(this.resourceFolder);
+  }
+
+  async isInstalled(): Promise<boolean> {
+    try {
+      const podApi = forCluster(this.cluster, Pod);
+      const examplePod = await podApi.get({name: "example-pod", namespace: "default"});
+
+      if (examplePod?.kind) {
+        console.log("found example-pod");
+        return true;
+      }
+    } catch(e) {
+      console.log("Error getting example-pod:", e);
+    }
+    console.log("didn't find example-pod");
+
+    return false;
+  }
+
+  async uninstall(): Promise<string> {
+    console.log("uninstalling example-pod");
+    return this.stack.kubectlDeleteFolder(this.resourceFolder);
+  }
+}
+
+

The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. +This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. +ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. +kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources. +Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. +kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources.

+

ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. +isInstalled() simply tries to find a pod named example-pod, as a way to determine if the pod is already installed. +This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code.

+

To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components:

+
 import React from "react";
+ import { Common, Renderer } from "@k8slens/extensions";
+ import { observer } from "mobx-react";
+ import { computed, observable, makeObservable } from "mobx";
+ import { ExampleClusterFeature } from "./example-cluster-feature";
+
+ const {
+   Component: {
+     SubTitle, Button,
+   }
+ } = Renderer;
+
+ interface Props {
+   cluster: Common.Catalog.KubernetesCluster;
+ }
+
+ @observer
+ export class ExampleClusterFeatureSettings extends React.Component<Props> {
+  constructor(props: Props) {
+    super(props);
+    makeObservable(this);
+  }
+
+  @observable installed = false;
+  @observable inProgress = false;
+
+  feature: ExampleClusterFeature;
+
+  async componentDidMount() {
+    this.feature = new ExampleClusterFeature(this.props.cluster);
+
+    await this.updateFeatureState();
+  }
+
+  async updateFeatureState() {
+    this.installed = await this.feature.isInstalled();
+  }
+
+   async save() {
+    this.inProgress = true;
+
+    try {
+      if (this.installed) {
+        await this.feature.uninstall();
+      } else {
+        await this.feature.install();
+      }
+    } finally {
+      this.inProgress = false;
+
+      await this.updateFeatureState();
+    }
+  }
+
+  @computed get buttonLabel() {
+    if (this.inProgress && this.installed) return "Uninstalling ...";
+    if (this.inProgress) return "Applying ...";
+
+    if (this.installed) {
+      return "Uninstall";
+    }
+
+    return "Apply";
+  }
+
+  render() {
+    return (
+      <>
+        <section>
+          <SubTitle title="Example Cluster Feature using a Resource Stack" />
+          <Button
+            label={this.buttonLabel}
+            waiting={this.inProgress}
+            onClick={() => this.save()}
+            primary />
+        </section>
+      </>
+    );
+  }
+}
+
+

The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. +ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount()). +The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress. +The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled(). +The inProgress value is true while waiting for the feature to be installed (or uninstalled).

+

Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a "waiting" animation while the install (or uninstall) is in progress. +Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel.

+

Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. +The ExampleClusterFeatureSettings class is marked as an @observer, and its constructor must call makeObservable(). +As well, the installed and inProgress fields are marked as @observable, ensuring that the button gets rerendered any time these fields change.

+

Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. +The ExampleExtension would look like this:

+
import { Common, Renderer } from "@k8slens/extensions";
+import { ExampleClusterFeatureSettings } from "./src/example-cluster-feature-settings"
+import React from "react"
+
+export default class ExampleExtension extends Renderer.LensExtension {
+  entitySettings = [
+    {
+      apiVersions: ["entity.k8slens.dev/v1alpha1"],
+      kind: "KubernetesCluster",
+      title: "Example Cluster Feature",
+      priority: 5,
+      components: {
+        View: ({ entity = null }: { entity: Common.Catalog.KubernetesCluster}) => {
+          return (
+            <ExampleClusterFeatureSettings cluster={entity} />
+          );
+        }
+      }
+    }
+  ];
+
+}
+
+

An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. +Because Lens's catalog can contain different kinds of entities, the kind must be identified. +For more details about the catalog see the Catalog Guide. +Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. +The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. +The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. +priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50.

+

The final result looks like this:

+

Cluster Feature Settings

+

ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. +In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) +Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. +The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/guides/stores/index.html b/v5.2.6/extensions/guides/stores/index.html new file mode 100644 index 0000000000..61b6d16473 --- /dev/null +++ b/v5.2.6/extensions/guides/stores/index.html @@ -0,0 +1,1017 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Stores - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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.

+

Store.ExtensionStore's child class will need to be created before being used. +It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. +It is also recommenced to delete the instance, using the inherited static method resetInstance(), in your extension's onDeactivate() method. +Everywhere else in your code you should use the getInstance() static method. +This is so that your data is kept up to date and not persisted longer than expected.

+

The following example code creates a store for the appPreferences guide example:

+
import { Common } from "@k8slens/extensions";
+import { observable, makeObservable } from "mobx";
+
+export type ExamplePreferencesModel = {
+  enabled: boolean;
+};
+
+export class ExamplePreferencesStore extends Common.Store.ExtensionStore<ExamplePreferencesModel> {
+
+  @observable  enabled = false;
+
+  private constructor() {
+    super({
+      configName: "example-preferences-store",
+      defaults: {
+        enabled: false
+      }
+    });
+    makeObservable(this);
+  }
+
+  protected fromStore({ enabled }: ExamplePreferencesModel): void {
+    this.enabled = enabled;
+  }
+
+  toJSON(): ExamplePreferencesModel {
+    return {
+      enabled: this.enabled
+    };
+  }
+}
+
+

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.

+

Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate(), and exported for use by other parts of the extension. +Note that ExamplePreferencesStore is a singleton. +Calling this function will create an instance if one has not been made before. +Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. +This provides some logical safety in that it limits where a new instance can be created. +Thus it prevents an instance from being created when the constructor args are not present at the call site.

+

If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance.

+

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 { Main } from "@k8slens/extensions";
+import { ExamplePreferencesStore } from "./src/example-preference-store";
+
+export default class ExampleMainExtension extends Main.LensExtension {
+  async onActivate() {
+    await ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);
+  }
+}
+
+

Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().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 { Renderer } 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 Renderer.LensExtension {
+
+  async onActivate() {
+    await ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);
+  }
+
+  appPreferences = [
+    {
+      title: "Example Preferences",
+      components: {
+        Input: () => <ExamplePreferenceInput />,
+        Hint: () => <ExamplePreferenceHint/>
+      }
+    }
+  ];
+}
+
+

Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension.

+

ExamplePreferenceInput is defined in ./src/example-preference.tsx:

+
import { Renderer } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
+import { ExamplePreferencesStore } from "./example-preference-store";
+
+const {
+  Component: {
+    Checkbox,
+  },
+} = Renderer;
+
+@observer
+export class ExamplePreferenceInput extends React.Component {
+
+  render() {
+    return (
+      <Checkbox
+        label="I understand appPreferences"
+        value={ExamplePreferencesStore.getInstance().enabled}
+        onChange={v => { ExamplePreferencesStore.getInstance().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/v5.2.6/extensions/guides/working-with-mobx/index.html b/v5.2.6/extensions/guides/working-with-mobx/index.html new file mode 100644 index 0000000000..383ec326cc --- /dev/null +++ b/v5.2.6/extensions/guides/working-with-mobx/index.html @@ -0,0 +1,905 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Working with MobX - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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/v5.2.6/extensions/testing-and-publishing/bundling/index.html b/v5.2.6/extensions/testing-and-publishing/bundling/index.html new file mode 100644 index 0000000000..860239d08c --- /dev/null +++ b/v5.2.6/extensions/testing-and-publishing/bundling/index.html @@ -0,0 +1,759 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Bundling - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ + + + +

Bundling

+ + + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v5.2.6/extensions/testing-and-publishing/publishing/index.html b/v5.2.6/extensions/testing-and-publishing/publishing/index.html new file mode 100644 index 0000000000..cab8600c94 --- /dev/null +++ b/v5.2.6/extensions/testing-and-publishing/publishing/index.html @@ -0,0 +1,954 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Publishing Extensions - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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/v5.2.6/extensions/testing-and-publishing/testing/index.html b/v5.2.6/extensions/testing-and-publishing/testing/index.html new file mode 100644 index 0000000000..edcc10b53d --- /dev/null +++ b/v5.2.6/extensions/testing-and-publishing/testing/index.html @@ -0,0 +1,1019 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Testing Extensions - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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 { Renderer } from "@k8slens/extensions";
+
+const {
+  Component: {
+    Icon,
+  },
+} = Renderer;
+
+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/v5.2.6/extensions/typedoc-readme.md.tpl b/v5.2.6/extensions/typedoc-readme.md.tpl new file mode 100644 index 0000000000..fe0bdb73a9 --- /dev/null +++ b/v5.2.6/extensions/typedoc-readme.md.tpl @@ -0,0 +1,7 @@ +# Extension API Reference + +## APIs + +- [Common](modules/common.md) +- [Main](modules/main.md) +- [Renderer](modules/renderer.md) diff --git a/v5.2.6/extensions/usage/images/extensions.png b/v5.2.6/extensions/usage/images/extensions.png new file mode 100644 index 0000000000..5deb8e4bd2 Binary files /dev/null and b/v5.2.6/extensions/usage/images/extensions.png differ diff --git a/v5.2.6/extensions/usage/index.html b/v5.2.6/extensions/usage/index.html new file mode 100644 index 0000000000..0cb13b18f8 --- /dev/null +++ b/v5.2.6/extensions/usage/index.html @@ -0,0 +1,825 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Using Extensions - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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/v5.2.6/img/favicon.ico b/v5.2.6/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v5.2.6/img/favicon.ico differ diff --git a/v5.2.6/img/lens-intro-video-screenshot.png b/v5.2.6/img/lens-intro-video-screenshot.png new file mode 100644 index 0000000000..2c5467b3f0 Binary files /dev/null and b/v5.2.6/img/lens-intro-video-screenshot.png differ diff --git a/v5.2.6/img/lens-logo-icon.svg b/v5.2.6/img/lens-logo-icon.svg new file mode 100644 index 0000000000..ede39244e5 --- /dev/null +++ b/v5.2.6/img/lens-logo-icon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + diff --git a/v5.2.6/img/play.svg b/v5.2.6/img/play.svg new file mode 100644 index 0000000000..a94d6e88ab --- /dev/null +++ b/v5.2.6/img/play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v5.2.6/index.html b/v5.2.6/index.html new file mode 100644 index 0000000000..d6b09b0b8c --- /dev/null +++ b/v5.2.6/index.html @@ -0,0 +1,963 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

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.

+

Important changes since Lens v4#

+

Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. +Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. +Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. +Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. +See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.

+

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/v5.2.6/search/search_index.json b/v5.2.6/search/search_index.json new file mode 100644 index 0000000000..cec4f60824 --- /dev/null +++ b/v5.2.6/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"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 . Important changes since Lens v4 # Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5. 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.","title":"Overview"},{"location":"#lens-extension-api","text":"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.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"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.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"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.","title":"How to Build Extensions"},{"location":"#whats-new","text":"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 .","title":"What's New"},{"location":"#important-changes-since-lens-v4","text":"Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.","title":"Important changes since Lens v4"},{"location":"#looking-for-help","text":"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 .","title":"Looking for Help"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"extensions/extension-migration/","text":"Lens v4 to v5 Extension Migration Notes # Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/extension-migration/#lens-v4-to-v5-extension-migration-notes","text":"Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/api/","text":"Extension API Reference # APIs # Common Main Renderer","title":"API Reference"},{"location":"extensions/api/#extension-api-reference","text":"","title":"Extension API Reference"},{"location":"extensions/api/#apis","text":"Common Main Renderer","title":"APIs"},{"location":"extensions/api/modules/","text":"@k8slens/extensions # Table of contents # Namespaces # Common Main Renderer","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#k8slensextensions","text":"","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/#namespaces","text":"Common Main Renderer","title":"Namespaces"},{"location":"extensions/api/classes/common.catalog.catalogcategory/","text":"Class: CatalogCategory # Common . Catalog .CatalogCategory Hierarchy # TypedEventEmitter < CatalogCategoryEvents , this> \u21b3 CatalogCategory \u21b3\u21b3 GeneralCategory \u21b3\u21b3 WebLinkCategory Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec Methods # addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # (EventEmitter as new () => TypedEmitter).constructor Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string kind # \u2022 Readonly Abstract kind : string metadata # \u2022 Abstract metadata : Object Type declaration # Name Type icon string name string spec # \u2022 Abstract spec : CatalogCategorySpec Methods # addListener # \u25b8 addListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).addListener emit # \u25b8 emit ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # (EventEmitter as new () => TypedEmitter).emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # (EventEmitter as new () => TypedEmitter).eventNames getId # \u25b8 getId (): string Returns # string getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).listeners off # \u25b8 off ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).off on # \u25b8 on ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).on once # \u25b8 once ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).once prependListener # \u25b8 prependListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): CatalogCategory Parameters # Name Type maxListeners number Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#class-catalogcategory","text":"Common . Catalog .CatalogCategory","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#hierarchy","text":"TypedEventEmitter < CatalogCategoryEvents , this> \u21b3 CatalogCategory \u21b3\u21b3 GeneralCategory \u21b3\u21b3 WebLinkCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#properties","text":"apiVersion kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#methods","text":"addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructor","text":"\u2022 new CatalogCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#metadata","text":"\u2022 Abstract metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#spec","text":"\u2022 Abstract spec : CatalogCategorySpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#addlistener","text":"\u25b8 addListener ( event , listener ): CatalogCategory","title":"addListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#emit","text":"\u25b8 emit ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#off","text":"\u25b8 off ( event , listener ): CatalogCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#on","text":"\u25b8 on ( event , listener ): CatalogCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#once","text":"\u25b8 once ( event , listener ): CatalogCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): CatalogCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): CatalogCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): CatalogCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): CatalogCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): CatalogCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/common.catalog.catalogentity/","text":"Class: CatalogEntity # Common . Catalog .CatalogEntity Type parameters # Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec Hierarchy # CatalogEntity \u21b3 GeneralEntity \u21b3 KubernetesCluster \u21b3 WebLink Implements # CatalogEntityKindData Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity ( data ) Type parameters # Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec Parameters # Name Type data CatalogEntityData Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Returns # string getName # \u25b8 getName (): string Returns # string onContextMenuOpen # \u25b8 Abstract onContextMenuOpen ( context ): void | Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise onRun # \u25b8 Optional Abstract onRun ( context ): void | Promise Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise onSettingsOpen # \u25b8 Abstract onSettingsOpen ( context ): void | Promise Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise ","title":"Class: CatalogEntity"},{"location":"extensions/api/classes/common.catalog.catalogentity/#class-catalogentitymetadata-status-spec","text":"Common . Catalog .CatalogEntity","title":"Class: CatalogEntity<Metadata, Status, Spec>"},{"location":"extensions/api/classes/common.catalog.catalogentity/#type-parameters","text":"Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/classes/common.catalog.catalogentity/#hierarchy","text":"CatalogEntity \u21b3 GeneralEntity \u21b3 KubernetesCluster \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.catalogentity/#implements","text":"CatalogEntityKindData","title":"Implements"},{"location":"extensions/api/classes/common.catalog.catalogentity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogentity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogentity/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructor","text":"\u2022 new CatalogEntity ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.catalogentity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogentity/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.catalogentity/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/common.catalog.catalogentity/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.catalogentity/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/common.catalog.catalogentity/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/common.catalog.catalogentity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogentity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.catalogentity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.catalogentity/#oncontextmenuopen","text":"\u25b8 Abstract onContextMenuOpen ( context ): void | Promise ","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.catalogentity/#onrun","text":"\u25b8 Optional Abstract onRun ( context ): void | Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.catalogentity/#onsettingsopen","text":"\u25b8 Abstract onSettingsOpen ( context ): void | Promise ","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.generalcategory/","text":"Class: GeneralCategory # Common . Catalog .GeneralCategory Hierarchy # CatalogCategory \u21b3 GeneralCategory Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec Methods # addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new GeneralCategory () Inherited from # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion kind # \u2022 Readonly kind : \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : Object Type declaration # Name Type group string names Object names.kind string versions { entityClass : typeof GeneralEntity ; name : string = \"v1alpha1\" }[] Overrides # CatalogCategory . spec Methods # addListener # \u25b8 addListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . addListener emit # \u25b8 emit ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # CatalogCategory . emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # CatalogCategory . eventNames getId # \u25b8 getId (): string Returns # string Inherited from # CatalogCategory . getId getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # CatalogCategory . getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # CatalogCategory . listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . listeners off # \u25b8 off ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . off on # \u25b8 on ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . on once # \u25b8 once ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . once prependListener # \u25b8 prependListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # GeneralCategory Inherited from # CatalogCategory . removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): GeneralCategory Parameters # Name Type maxListeners number Returns # GeneralCategory Inherited from # CatalogCategory . setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: GeneralCategory"},{"location":"extensions/api/classes/common.catalog.generalcategory/#class-generalcategory","text":"Common . Catalog .GeneralCategory","title":"Class: GeneralCategory"},{"location":"extensions/api/classes/common.catalog.generalcategory/#hierarchy","text":"CatalogCategory \u21b3 GeneralCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.generalcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalcategory/#properties","text":"apiVersion kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalcategory/#methods","text":"addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructor","text":"\u2022 new GeneralCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.generalcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalcategory/#apiversion","text":"\u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.generalcategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.generalcategory/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.generalcategory/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/common.catalog.generalcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalcategory/#addlistener","text":"\u25b8 addListener ( event , listener ): GeneralCategory","title":"addListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#emit","text":"\u25b8 emit ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.generalcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.generalcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.generalcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.generalcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#off","text":"\u25b8 off ( event , listener ): GeneralCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.generalcategory/#on","text":"\u25b8 on ( event , listener ): GeneralCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.generalcategory/#once","text":"\u25b8 once ( event , listener ): GeneralCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.generalcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): GeneralCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): GeneralCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): GeneralCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): GeneralCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): GeneralCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/common.catalog.generalentity/","text":"Class: GeneralEntity # Common . Catalog .GeneralEntity Hierarchy # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec> \u21b3 GeneralEntity Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec> Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : GeneralEntitySpec Inherited from # CatalogEntity . spec status # \u2022 status : CatalogEntityStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen (): void Returns # void Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun (): Promise Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/common.catalog.generalentity/#class-generalentity","text":"Common . Catalog .GeneralEntity","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/common.catalog.generalentity/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec> \u21b3 GeneralEntity","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.generalentity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalentity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalentity/#methods","text":"getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructor","text":"\u2022 new GeneralEntity ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.generalentity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalentity/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.generalentity/#kind","text":"\u2022 Readonly kind : \"General\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.generalentity/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.generalentity/#spec","text":"\u2022 spec : GeneralEntitySpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.generalentity/#status","text":"\u2022 status : CatalogEntityStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.generalentity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalentity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.generalentity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.generalentity/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen (): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.generalentity/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/common.catalog.generalentity/#onrun","text":"\u25b8 onRun (): Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.generalentity/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Hierarchy # CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster ( data ) Parameters # Name Type data CatalogEntityData < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"KubernetesCluster\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : KubernetesClusterMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : KubernetesClusterSpec Inherited from # CatalogEntity . spec status # \u2022 status : KubernetesClusterStatus Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"KubernetesCluster\" Methods # connect # \u25b8 connect (): Promise Returns # Promise disconnect # \u25b8 disconnect (): Promise Returns # Promise getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun ( context ): Promise Parameters # Name Type context CatalogEntityActionContext Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#class-kubernetescluster","text":"Common . Catalog .KubernetesCluster","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#hierarchy","text":"CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#methods","text":"connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructor","text":"\u2022 new KubernetesCluster ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#kind","text":"\u2022 Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#metadata","text":"\u2022 metadata : KubernetesClusterMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#spec","text":"\u2022 spec : KubernetesClusterSpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#status","text":"\u2022 status : KubernetesClusterStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#kind_1","text":"\u25aa Static Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#connect","text":"\u25b8 connect (): Promise ","title":"connect"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#disconnect","text":"\u25b8 disconnect (): Promise ","title":"disconnect"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise ","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#onrun","text":"\u25b8 onRun ( context ): Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.weblink/","text":"Class: WebLink # Common . Catalog .WebLink Hierarchy # CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : WebLinkSpec Inherited from # CatalogEntity . spec status # \u2022 status : WebLinkStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/common.catalog.weblink/#class-weblink","text":"Common . Catalog .WebLink","title":"Class: WebLink"},{"location":"extensions/api/classes/common.catalog.weblink/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.weblink/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.weblink/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblink/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblink/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblink/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblink/#constructor","text":"\u2022 new WebLink ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.weblink/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblink/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.weblink/#kind","text":"\u2022 Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.weblink/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.weblink/#spec","text":"\u2022 spec : WebLinkSpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.weblink/#status","text":"\u2022 status : WebLinkStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.weblink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblink/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.weblink/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.weblink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise ","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.weblink/#onrun","text":"\u25b8 onRun (): Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.weblink/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/","text":"Class: WebLinkCategory # Common . Catalog .WebLinkCategory Hierarchy # CatalogCategory \u21b3 WebLinkCategory Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec onAdd Methods # addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new WebLinkCategory () Overrides # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion kind # \u2022 Readonly kind : \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : Object Type declaration # Name Type group string names Object names.kind string versions { entityClass : typeof WebLink ; name : string = \"v1alpha1\" }[] Overrides # CatalogCategory . spec onAdd # \u25aa Static Optional onAdd : () => void Type declaration # \u25b8 (): void Returns # void Methods # addListener # \u25b8 addListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . addListener emit # \u25b8 emit ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # CatalogCategory . emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # CatalogCategory . eventNames getId # \u25b8 getId (): string Returns # string Inherited from # CatalogCategory . getId getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # CatalogCategory . getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # CatalogCategory . listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . listeners off # \u25b8 off ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . off on # \u25b8 on ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . on once # \u25b8 once ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . once prependListener # \u25b8 prependListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # WebLinkCategory Inherited from # CatalogCategory . removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): WebLinkCategory Parameters # Name Type maxListeners number Returns # WebLinkCategory Inherited from # CatalogCategory . setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: WebLinkCategory"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#class-weblinkcategory","text":"Common . Catalog .WebLinkCategory","title":"Class: WebLinkCategory"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#hierarchy","text":"CatalogCategory \u21b3 WebLinkCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#properties","text":"apiVersion kind metadata spec onAdd","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#methods","text":"addListener emit eventNames getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructor","text":"\u2022 new WebLinkCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#apiversion","text":"\u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#onadd","text":"\u25aa Static Optional onAdd : () => void","title":"onAdd"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#addlistener","text":"\u25b8 addListener ( event , listener ): WebLinkCategory","title":"addListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#emit","text":"\u25b8 emit ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#off","text":"\u25b8 off ( event , listener ): WebLinkCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#on","text":"\u25b8 on ( event , listener ): WebLinkCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#once","text":"\u25b8 once ( event , listener ): WebLinkCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): WebLinkCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): WebLinkCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): WebLinkCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): WebLinkCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): WebLinkCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/common.store.extensionstore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Type parameters # Name T Hierarchy # BaseStore \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # extension params storeConfig syncDisposers Accessors # name path syncMainChannel syncRendererChannel Methods # applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance Constructors # constructor # \u2022 Protected new ExtensionStore ( params ) Type parameters # Name T Parameters # Name Type params BaseStoreParams Inherited from # BaseStore.constructor Properties # extension # \u2022 Protected extension : LensExtension params # \u2022 Protected params : BaseStoreParams Inherited from # BaseStore.params storeConfig # \u2022 Protected Optional storeConfig : Conf Inherited from # BaseStore.storeConfig syncDisposers # \u2022 Protected syncDisposers : Disposer [] = [] Inherited from # BaseStore.syncDisposers Accessors # name # \u2022 get name (): string Returns # string path # \u2022 get path (): string Returns # string syncMainChannel # \u2022 Protected get syncMainChannel (): string Returns # string syncRendererChannel # \u2022 Protected get syncRendererChannel (): string Returns # string Methods # applyWithoutSync # \u25b8 Protected applyWithoutSync ( callback ): void Parameters # Name Type callback () => void Returns # void Inherited from # BaseStore.applyWithoutSync cwd # \u25b8 Protected cwd (): string Returns # string Overrides # BaseStore.cwd disableSync # \u25b8 disableSync (): void Returns # void Inherited from # BaseStore.disableSync enableSync # \u25b8 enableSync (): void Returns # void Inherited from # BaseStore.enableSync fromStore # \u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous. Parameters # Name Type Description data T the parsed information read from the stored JSON file Returns # void Inherited from # BaseStore.fromStore load # \u25b8 load (): void Returns # void Overrides # BaseStore.load loadExtension # \u25b8 loadExtension ( extension ): void Parameters # Name Type extension LensExtension Returns # void onModelChange # \u25b8 Protected onModelChange ( model ): Promise Parameters # Name Type model T Returns # Promise Inherited from # BaseStore.onModelChange onSync # \u25b8 Protected onSync ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSync onSyncFromMain # \u25b8 Protected onSyncFromMain ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSyncFromMain saveToFile # \u25b8 Protected saveToFile ( model ): Promise Parameters # Name Type model T Returns # Promise Inherited from # BaseStore.saveToFile toJSON # \u25b8 Abstract toJSON (): T toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation 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 Inherited from # BaseStore.toJSON unregisterIpcListener # \u25b8 unregisterIpcListener (): void Returns # void Inherited from # BaseStore.unregisterIpcListener createInstance # \u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # BaseStore.createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # BaseStore.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # BaseStore.resetInstance","title":"Class: ExtensionStore"},{"location":"extensions/api/classes/common.store.extensionstore/#class-extensionstoret","text":"Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: ExtensionStore<T>"},{"location":"extensions/api/classes/common.store.extensionstore/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/classes/common.store.extensionstore/#hierarchy","text":"BaseStore \u21b3 ExtensionStore","title":"Hierarchy"},{"location":"extensions/api/classes/common.store.extensionstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.store.extensionstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.store.extensionstore/#properties","text":"extension params storeConfig syncDisposers","title":"Properties"},{"location":"extensions/api/classes/common.store.extensionstore/#accessors","text":"name path syncMainChannel syncRendererChannel","title":"Accessors"},{"location":"extensions/api/classes/common.store.extensionstore/#methods","text":"applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/common.store.extensionstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.store.extensionstore/#constructor","text":"\u2022 Protected new ExtensionStore ( params )","title":"constructor"},{"location":"extensions/api/classes/common.store.extensionstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.store.extensionstore/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/common.store.extensionstore/#params","text":"\u2022 Protected params : BaseStoreParams ","title":"params"},{"location":"extensions/api/classes/common.store.extensionstore/#storeconfig","text":"\u2022 Protected Optional storeConfig : Conf ","title":"storeConfig"},{"location":"extensions/api/classes/common.store.extensionstore/#syncdisposers","text":"\u2022 Protected syncDisposers : Disposer [] = []","title":"syncDisposers"},{"location":"extensions/api/classes/common.store.extensionstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/common.store.extensionstore/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/common.store.extensionstore/#path","text":"\u2022 get path (): string","title":"path"},{"location":"extensions/api/classes/common.store.extensionstore/#syncmainchannel","text":"\u2022 Protected get syncMainChannel (): string","title":"syncMainChannel"},{"location":"extensions/api/classes/common.store.extensionstore/#syncrendererchannel","text":"\u2022 Protected get syncRendererChannel (): string","title":"syncRendererChannel"},{"location":"extensions/api/classes/common.store.extensionstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.store.extensionstore/#applywithoutsync","text":"\u25b8 Protected applyWithoutSync ( callback ): void","title":"applyWithoutSync"},{"location":"extensions/api/classes/common.store.extensionstore/#cwd","text":"\u25b8 Protected cwd (): string","title":"cwd"},{"location":"extensions/api/classes/common.store.extensionstore/#disablesync","text":"\u25b8 disableSync (): void","title":"disableSync"},{"location":"extensions/api/classes/common.store.extensionstore/#enablesync","text":"\u25b8 enableSync (): void","title":"enableSync"},{"location":"extensions/api/classes/common.store.extensionstore/#fromstore","text":"\u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous.","title":"fromStore"},{"location":"extensions/api/classes/common.store.extensionstore/#load","text":"\u25b8 load (): void","title":"load"},{"location":"extensions/api/classes/common.store.extensionstore/#loadextension","text":"\u25b8 loadExtension ( extension ): void","title":"loadExtension"},{"location":"extensions/api/classes/common.store.extensionstore/#onmodelchange","text":"\u25b8 Protected onModelChange ( model ): Promise ","title":"onModelChange"},{"location":"extensions/api/classes/common.store.extensionstore/#onsync","text":"\u25b8 Protected onSync ( model ): void","title":"onSync"},{"location":"extensions/api/classes/common.store.extensionstore/#onsyncfrommain","text":"\u25b8 Protected onSyncFromMain ( model ): void","title":"onSyncFromMain"},{"location":"extensions/api/classes/common.store.extensionstore/#savetofile","text":"\u25b8 Protected saveToFile ( model ): Promise ","title":"saveToFile"},{"location":"extensions/api/classes/common.store.extensionstore/#tojson","text":"\u25b8 Abstract toJSON (): T toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state. It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state.","title":"toJSON"},{"location":"extensions/api/classes/common.store.extensionstore/#unregisteripclistener","text":"\u25b8 unregisterIpcListener (): void","title":"unregisterIpcListener"},{"location":"extensions/api/classes/common.store.extensionstore/#createinstance","text":"\u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/common.store.extensionstore/#getinstance","text":"\u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/common.store.extensionstore/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/common.util.singleton/","text":"Class: Singleton # Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # Singleton \u21b3 TerminalStore Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void","title":"Class: Singleton"},{"location":"extensions/api/classes/common.util.singleton/#class-singleton","text":"Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: Singleton"},{"location":"extensions/api/classes/common.util.singleton/#hierarchy","text":"Singleton \u21b3 TerminalStore","title":"Hierarchy"},{"location":"extensions/api/classes/common.util.singleton/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.util.singleton/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.util.singleton/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/common.util.singleton/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.util.singleton/#constructor","text":"\u2022 new Singleton ()","title":"constructor"},{"location":"extensions/api/classes/common.util.singleton/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.util.singleton/#createinstance","text":"\u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/common.util.singleton/#getinstance","text":"\u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/common.util.singleton/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/","text":"Class: CatalogEntityRegistry # Main . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Methods # getItemsForApiKind Constructors # constructor # \u2022 new CatalogEntityRegistry () Methods # getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): T [] Type parameters # Name Type T T : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T> Parameters # Name Type apiVersion string kind string Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#class-catalogentityregistry","text":"Main . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#methods","text":"getItemsForApiKind","title":"Methods"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/main.ipc/","text":"Class: Ipc # Main .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast handle listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@43866 extension # \u2022 Protected extension : LensExtension Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ... args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast handle # \u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled Parameters # Name Type Description channel string The name of the RPC handler ( event : IpcMainInvokeEvent , ... args : any []) => any The remote procedure that is called Returns # void listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension Parameters # Name Type Description channel string The channel to listen for broadcasts on listener ( event : IpcRendererEvent , ... args : any []) => any The function that will be called with the arguments of the broadcast Returns # Disposer An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called createInstance # \u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/main.ipc/#class-ipc","text":"Main .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/main.ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/main.ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/main.ipc/#methods","text":"broadcast handle listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/main.ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/main.ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/main.ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/main.ipc/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/main.ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.ipc/#broadcast","text":"\u25b8 broadcast ( channel , ... args ): void","title":"broadcast"},{"location":"extensions/api/classes/main.ipc/#handle","text":"\u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled","title":"handle"},{"location":"extensions/api/classes/main.ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension","title":"listen"},{"location":"extensions/api/classes/main.ipc/#createinstance","text":"\u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/main.ipc/#getinstance","text":"\u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/main.ipc/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/main.lensextension/","text":"Class: LensExtension # Main .LensExtension Hierarchy # LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # [Disposers] appMenus id isBundled manifest manifestPath protocolHandlers Accessors # description name version Methods # addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource Constructors # constructor # \u2022 new LensExtension ( __namedParameters ) Parameters # Name Type __namedParameters InstalledExtension Inherited from # LensExtension.constructor Properties # [Disposers] # \u2022 [Disposers] : ExtendableDisposer Inherited from # LensExtension.__@Disposers@24661 appMenus # \u2022 appMenus : MenuRegistration [] = [] id # \u2022 Readonly id : string Inherited from # LensExtension.id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension.isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension.manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension.manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] = [] Inherited from # LensExtension.protocolHandlers Accessors # description # \u2022 get description (): string Returns # string name # \u2022 get name (): string Returns # string version # \u2022 get version (): string Returns # string Methods # addCatalogSource # \u25b8 addCatalogSource ( id , source ): void Parameters # Name Type id string source IObservableArray < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # void disable # \u25b8 disable (): Promise Returns # Promise Inherited from # LensExtension.disable enable # \u25b8 enable ( register ): Promise Parameters # Name Type register ( ext : LensExtension ) => Promise Returns # Promise Inherited from # LensExtension.enable getExtensionFileFolder # \u25b8 getExtensionFileFolder (): Promise 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 obfuscation of the folder name. Returns # Promise Inherited from # LensExtension.getExtensionFileFolder navigate # \u25b8 navigate ( pageId? , params? , frameId? ): Promise Parameters # Name Type pageId? string params? Record frameId? number Returns # Promise onActivate # \u25b8 Protected onActivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onDeactivate removeCatalogSource # \u25b8 removeCatalogSource ( id ): void Parameters # Name Type id string Returns # void","title":"Class: LensExtension"},{"location":"extensions/api/classes/main.lensextension/#class-lensextension","text":"Main .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/main.lensextension/#hierarchy","text":"LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/main.lensextension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.lensextension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.lensextension/#properties","text":"[Disposers] appMenus id isBundled manifest manifestPath protocolHandlers","title":"Properties"},{"location":"extensions/api/classes/main.lensextension/#accessors","text":"description name version","title":"Accessors"},{"location":"extensions/api/classes/main.lensextension/#methods","text":"addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource","title":"Methods"},{"location":"extensions/api/classes/main.lensextension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.lensextension/#constructor","text":"\u2022 new LensExtension ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/main.lensextension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/main.lensextension/#disposers","text":"\u2022 [Disposers] : ExtendableDisposer","title":"[Disposers]"},{"location":"extensions/api/classes/main.lensextension/#appmenus","text":"\u2022 appMenus : MenuRegistration [] = []","title":"appMenus"},{"location":"extensions/api/classes/main.lensextension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/main.lensextension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/main.lensextension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/main.lensextension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/main.lensextension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration [] = []","title":"protocolHandlers"},{"location":"extensions/api/classes/main.lensextension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/main.lensextension/#description","text":"\u2022 get description (): string","title":"description"},{"location":"extensions/api/classes/main.lensextension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/main.lensextension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/main.lensextension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.lensextension/#addcatalogsource","text":"\u25b8 addCatalogSource ( id , source ): void","title":"addCatalogSource"},{"location":"extensions/api/classes/main.lensextension/#disable","text":"\u25b8 disable (): Promise ","title":"disable"},{"location":"extensions/api/classes/main.lensextension/#enable","text":"\u25b8 enable ( register ): Promise ","title":"enable"},{"location":"extensions/api/classes/main.lensextension/#getextensionfilefolder","text":"\u25b8 getExtensionFileFolder (): Promise 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 obfuscation of the folder name.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/main.lensextension/#navigate","text":"\u25b8 navigate ( pageId? , params? , frameId? ): Promise ","title":"navigate"},{"location":"extensions/api/classes/main.lensextension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise ","title":"onActivate"},{"location":"extensions/api/classes/main.lensextension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise ","title":"onDeactivate"},{"location":"extensions/api/classes/main.lensextension/#removecatalogsource","text":"\u25b8 removeCatalogSource ( id ): void","title":"removeCatalogSource"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/","text":"Class: CatalogEntityRegistry # Renderer . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Accessors # activeEntity entities Methods # getById getItemsForApiKind getItemsForCategory Constructors # constructor # \u2022 new CatalogEntityRegistry () Accessors # activeEntity # \u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > entities # \u2022 get entities (): Map > Returns # Map > Methods # getById # \u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): T [] Type parameters # Name Type T T : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T> Parameters # Name Type apiVersion string kind string Returns # T [] getItemsForCategory # \u25b8 getItemsForCategory ( category ): T [] Type parameters # Name Type T T : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T> Parameters # Name Type category CatalogCategory Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#class-catalogentityregistry","text":"Renderer . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#accessors","text":"activeEntity entities","title":"Accessors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#methods","text":"getById getItemsForApiKind getItemsForCategory","title":"Methods"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#activeentity","text":"\u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity","title":"activeEntity"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#entities","text":"\u2022 get entities (): Map >","title":"entities"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getbyid","text":"\u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"getById"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getitemsforcategory","text":"\u25b8 getItemsForCategory ( category ): T []","title":"getItemsForCategory"},{"location":"extensions/api/classes/renderer.component.badge/","text":"Class: Badge # Renderer . Component .Badge Hierarchy # Component < BadgeProps > \u21b3 Badge Table of contents # Constructors # constructor Properties # context elem isExpanded props refs state badgeMeta contextType defaultProps Accessors # isExpandable Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate Constructors # constructor # \u2022 new Badge ( props ) Parameters # Name Type props BadgeProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context elem # \u2022 elem : HTMLElement isExpanded # \u2022 isExpanded : boolean = false props # \u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state badgeMeta # \u25aa Static badgeMeta : Object Type declaration # Name Type hasTextSelected boolean contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : Partial < BadgeProps > Accessors # isExpandable # \u2022 get isExpandable (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onMouseUp # \u25b8 onMouseUp (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < BadgeProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Badge"},{"location":"extensions/api/classes/renderer.component.badge/#class-badge","text":"Renderer . Component .Badge","title":"Class: Badge"},{"location":"extensions/api/classes/renderer.component.badge/#hierarchy","text":"Component < BadgeProps > \u21b3 Badge","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.badge/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.badge/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.badge/#properties","text":"context elem isExpanded props refs state badgeMeta contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.badge/#accessors","text":"isExpandable","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.badge/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.badge/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.badge/#constructor","text":"\u2022 new Badge ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.badge/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.badge/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.badge/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.badge/#isexpanded","text":"\u2022 isExpanded : boolean = false","title":"isExpanded"},{"location":"extensions/api/classes/renderer.component.badge/#props","text":"\u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.badge/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.badge/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.badge/#badgemeta","text":"\u25aa Static badgeMeta : Object","title":"badgeMeta"},{"location":"extensions/api/classes/renderer.component.badge/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.badge/#defaultprops","text":"\u25aa Static defaultProps : Partial < BadgeProps >","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.badge/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.badge/#isexpandable","text":"\u2022 get isExpandable (): boolean","title":"isExpandable"},{"location":"extensions/api/classes/renderer.component.badge/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#onmouseup","text":"\u25b8 onMouseUp (): void","title":"onMouseUp"},{"location":"extensions/api/classes/renderer.component.badge/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.badge/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.badge/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/","text":"Class: BarChart # Renderer . Component .BarChart Hierarchy # Component \u21b3 BarChart Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new BarChart ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new BarChart ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: BarChart"},{"location":"extensions/api/classes/renderer.component.barchart/#class-barchart","text":"Renderer . Component .BarChart","title":"Class: BarChart"},{"location":"extensions/api/classes/renderer.component.barchart/#hierarchy","text":"Component \u21b3 BarChart","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.barchart/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.barchart/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.barchart/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.barchart/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.barchart/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.barchart/#constructor","text":"\u2022 new BarChart ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.barchart/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.barchart/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.barchart/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.barchart/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.barchart/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.barchart/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.barchart/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.barchart/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.barchart/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.barchart/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.button/","text":"Class: Button # Renderer . Component .Button Hierarchy # PureComponent < ButtonProps , Object > \u21b3 Button Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Button ( props ) Parameters # Name Type props ButtonProps | Readonly < ButtonProps > Inherited from # React.PureComponent.constructor \u2022 new Button ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props ButtonProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any 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 Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ButtonProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Button"},{"location":"extensions/api/classes/renderer.component.button/#class-button","text":"Renderer . Component .Button","title":"Class: Button"},{"location":"extensions/api/classes/renderer.component.button/#hierarchy","text":"PureComponent < ButtonProps , Object > \u21b3 Button","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.button/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.button/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.button/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.button/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.button/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.button/#constructor","text":"\u2022 new Button ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.button/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.button/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.button/#props","text":"\u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.button/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.button/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.button/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.button/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.button/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.button/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.button/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.button/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.button/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.button/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.button/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.button/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.button/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.button/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.button/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.button/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/","text":"Class: Checkbox # Renderer . Component .Checkbox Hierarchy # PureComponent < CheckboxProps > \u21b3 Checkbox Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate Constructors # constructor # \u2022 new Checkbox ( props ) Parameters # Name Type props CheckboxProps | Readonly < CheckboxProps > Inherited from # React.PureComponent.constructor \u2022 new Checkbox ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props CheckboxProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any 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 Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < CheckboxProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < CheckboxProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < CheckboxProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < CheckboxProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < CheckboxProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate getValue # \u25b8 getValue (): boolean Returns # boolean onChange # \u25b8 onChange ( evt ): void Parameters # Name Type evt ChangeEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < CheckboxProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Checkbox"},{"location":"extensions/api/classes/renderer.component.checkbox/#class-checkbox","text":"Renderer . Component .Checkbox","title":"Class: Checkbox"},{"location":"extensions/api/classes/renderer.component.checkbox/#hierarchy","text":"PureComponent < CheckboxProps > \u21b3 Checkbox","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.checkbox/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.checkbox/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.checkbox/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructor","text":"\u2022 new Checkbox ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.checkbox/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.checkbox/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.checkbox/#props","text":"\u2022 Readonly props : Readonly < CheckboxProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.checkbox/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.checkbox/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.checkbox/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.checkbox/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#getvalue","text":"\u25b8 getValue (): boolean","title":"getValue"},{"location":"extensions/api/classes/renderer.component.checkbox/#onchange","text":"\u25b8 onChange ( evt ): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.checkbox/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.checkbox/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.checkbox/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.commandoverlay/","text":"Class: CommandOverlay # Renderer . Component .CommandOverlay Table of contents # Constructors # constructor Accessors # component isOpen Methods # close open Constructors # constructor # \u2022 new CommandOverlay () Accessors # component # \u2022 Static get component (): ReactElement > Returns # ReactElement > isOpen # \u2022 Static get isOpen (): boolean Returns # boolean Methods # close # \u25b8 Static close (): void Returns # void open # \u25b8 Static open ( component ): void Parameters # Name Type component ReactElement > Returns # void","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#class-commandoverlay","text":"Renderer . Component .CommandOverlay","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#accessors","text":"component isOpen","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructor","text":"\u2022 new CommandOverlay ()","title":"constructor"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#component","text":"\u2022 Static get component (): ReactElement >","title":"component"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#isopen","text":"\u2022 Static get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#close","text":"\u25b8 Static close (): void","title":"close"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#open","text":"\u25b8 Static open ( component ): void","title":"open"},{"location":"extensions/api/classes/renderer.component.confirmdialog/","text":"Class: ConfirmDialog # Renderer . Component .ConfirmDialog Hierarchy # Component < ConfirmDialogProps > \u21b3 ConfirmDialog Table of contents # Constructors # constructor Properties # context isSaving props refs state contextType defaultParams Accessors # params Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open Constructors # constructor # \u2022 new ConfirmDialog ( props ) Parameters # Name Type props ConfirmDialogProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context isSaving # \u2022 isSaving : boolean = false props # \u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultParams # \u25aa Static defaultParams : Partial < ConfirmDialogParams > Accessors # params # \u2022 get params (): ConfirmDialogParams Returns # ConfirmDialogParams Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate close # \u25b8 close (): Promise Returns # Promise componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate ok # \u25b8 ok (): Promise Returns # Promise onClose # \u25b8 onClose (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ConfirmDialogProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate confirm # \u25b8 Static confirm ( params ): Promise Parameters # Name Type params ConfirmDialogBooleanParams Returns # Promise open # \u25b8 Static open ( params ): void Parameters # Name Type params ConfirmDialogParams Returns # void","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#class-confirmdialog","text":"Renderer . Component .ConfirmDialog","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#hierarchy","text":"Component < ConfirmDialogProps > \u21b3 ConfirmDialog","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#properties","text":"context isSaving props refs state contextType defaultParams","title":"Properties"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#accessors","text":"params","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open","title":"Methods"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructor","text":"\u2022 new ConfirmDialog ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#issaving","text":"\u2022 isSaving : boolean = false","title":"isSaving"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#props","text":"\u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#defaultparams","text":"\u25aa Static defaultParams : Partial < ConfirmDialogParams >","title":"defaultParams"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#params","text":"\u2022 get params (): ConfirmDialogParams","title":"params"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#close","text":"\u25b8 close (): Promise ","title":"close"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#ok","text":"\u25b8 ok (): Promise ","title":"ok"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#onclose","text":"\u25b8 onClose (): void","title":"onClose"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#confirm","text":"\u25b8 Static confirm ( params ): Promise ","title":"confirm"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#open","text":"\u25b8 Static open ( params ): void","title":"open"},{"location":"extensions/api/classes/renderer.component.dialog/","text":"Class: Dialog # Renderer . Component .Dialog Hierarchy # PureComponent < DialogProps , DialogState> \u21b3 Dialog Table of contents # Constructors # constructor Properties # closeOnNavigate context props refs state contextType defaultProps Accessors # elem isOpen Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClickOutside onClose onEscapeKey onOpen open render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new Dialog ( props ) Parameters # Name Type props DialogProps | Readonly < DialogProps > Inherited from # React.PureComponent.constructor \u2022 new Dialog ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DialogProps context any Inherited from # React.PureComponent.constructor Properties # closeOnNavigate # \u2022 closeOnNavigate : IReactionDisposer context # \u2022 context : any 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 Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < DialogProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : DialogState Overrides # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : DialogProps Accessors # elem # \u2022 get elem (): HTMLElement Returns # HTMLElement isOpen # \u2022 get isOpen (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DialogProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DialogProps > nextState Readonly nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps DialogProps Returns # void Overrides # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DialogProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DialogProps > nextState Readonly nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < DialogProps > prevState Readonly Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onClose # \u25b8 onClose (): void Returns # void onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onOpen # \u25b8 onOpen (): void Returns # void open # \u25b8 open (): void Returns # void render # \u25b8 render (): ReactPortal Returns # ReactPortal Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : \"isOpen\" Parameters # Name Type state DialogState | ( prevState : Readonly , props : Readonly < DialogProps >) => DialogState | Pick | Pick callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < DialogProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate toggle # \u25b8 toggle ( isOpen ): void Parameters # Name Type isOpen boolean Returns # void","title":"Class: Dialog"},{"location":"extensions/api/classes/renderer.component.dialog/#class-dialog","text":"Renderer . Component .Dialog","title":"Class: Dialog"},{"location":"extensions/api/classes/renderer.component.dialog/#hierarchy","text":"PureComponent < DialogProps , DialogState> \u21b3 Dialog","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.dialog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.dialog/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.dialog/#properties","text":"closeOnNavigate context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.dialog/#accessors","text":"elem isOpen","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.dialog/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClickOutside onClose onEscapeKey onOpen open render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/renderer.component.dialog/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.dialog/#constructor","text":"\u2022 new Dialog ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.dialog/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.dialog/#closeonnavigate","text":"\u2022 closeOnNavigate : IReactionDisposer","title":"closeOnNavigate"},{"location":"extensions/api/classes/renderer.component.dialog/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.dialog/#props","text":"\u2022 Readonly props : Readonly < DialogProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.dialog/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.dialog/#state","text":"\u2022 state : DialogState","title":"state"},{"location":"extensions/api/classes/renderer.component.dialog/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.dialog/#defaultprops","text":"\u25aa Static defaultProps : DialogProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.dialog/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.dialog/#elem","text":"\u2022 get elem (): HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.dialog/#isopen","text":"\u2022 get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/renderer.component.dialog/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.dialog/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.dialog/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.dialog/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/renderer.component.dialog/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.dialog/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.dialog/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.dialog/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.dialog/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.dialog/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/renderer.component.dialog/#onclose","text":"\u25b8 onClose (): void","title":"onClose"},{"location":"extensions/api/classes/renderer.component.dialog/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/renderer.component.dialog/#onopen","text":"\u25b8 onOpen (): void","title":"onOpen"},{"location":"extensions/api/classes/renderer.component.dialog/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/classes/renderer.component.dialog/#render","text":"\u25b8 render (): ReactPortal","title":"render"},{"location":"extensions/api/classes/renderer.component.dialog/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.dialog/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.dialog/#toggle","text":"\u25b8 toggle ( isOpen ): void","title":"toggle"},{"location":"extensions/api/classes/renderer.component.drawer/","text":"Class: Drawer # Renderer . Component .Drawer Hierarchy # Component < DrawerProps > \u21b3 Drawer Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate copyK8sObjName forceUpdate getSnapshotBeforeUpdate onClickOutside onEscapeKey onMouseDown render restoreScrollPos saveScrollPos setState shouldComponentUpdate Constructors # constructor # \u2022 new Drawer ( props ) Parameters # Name Type props DrawerProps | Readonly < DrawerProps > Inherited from # React.Component.constructor \u2022 new Drawer ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < DrawerProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate copyK8sObjName # \u25b8 copyK8sObjName (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < DrawerProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onMouseDown # \u25b8 onMouseDown ( evt ): void Parameters # Name Type evt MouseEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render restoreScrollPos # \u25b8 restoreScrollPos (): void Returns # void saveScrollPos # \u25b8 saveScrollPos (): void Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Drawer"},{"location":"extensions/api/classes/renderer.component.drawer/#class-drawer","text":"Renderer . Component .Drawer","title":"Class: Drawer"},{"location":"extensions/api/classes/renderer.component.drawer/#hierarchy","text":"Component < DrawerProps > \u21b3 Drawer","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.drawer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.drawer/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawer/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawer/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate copyK8sObjName forceUpdate getSnapshotBeforeUpdate onClickOutside onEscapeKey onMouseDown render restoreScrollPos saveScrollPos setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawer/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawer/#constructor","text":"\u2022 new Drawer ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.drawer/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawer/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.drawer/#props","text":"\u2022 Readonly props : Readonly < DrawerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.drawer/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.drawer/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/renderer.component.drawer/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.drawer/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.drawer/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawer/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawer/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawer/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawer/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/renderer.component.drawer/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.drawer/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.drawer/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.drawer/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawer/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawer/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.drawer/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawer/#copyk8sobjname","text":"\u25b8 copyK8sObjName (): void","title":"copyK8sObjName"},{"location":"extensions/api/classes/renderer.component.drawer/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.drawer/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.drawer/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/renderer.component.drawer/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/renderer.component.drawer/#onmousedown","text":"\u25b8 onMouseDown ( evt ): void","title":"onMouseDown"},{"location":"extensions/api/classes/renderer.component.drawer/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.drawer/#restorescrollpos","text":"\u25b8 restoreScrollPos (): void","title":"restoreScrollPos"},{"location":"extensions/api/classes/renderer.component.drawer/#savescrollpos","text":"\u25b8 saveScrollPos (): void","title":"saveScrollPos"},{"location":"extensions/api/classes/renderer.component.drawer/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.drawer/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/","text":"Class: DrawerItem # Renderer . Component .DrawerItem Hierarchy # Component < DrawerItemProps > \u21b3 DrawerItem Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new DrawerItem ( props ) Parameters # Name Type props DrawerItemProps | Readonly < DrawerItemProps > Inherited from # React.Component.constructor \u2022 new DrawerItem ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerItemProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerItemProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerItemProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < DrawerItemProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerItemProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < DrawerItemProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerItemProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: DrawerItem"},{"location":"extensions/api/classes/renderer.component.draweritem/#class-draweritem","text":"Renderer . Component .DrawerItem","title":"Class: DrawerItem"},{"location":"extensions/api/classes/renderer.component.draweritem/#hierarchy","text":"Component < DrawerItemProps > \u21b3 DrawerItem","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.draweritem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.draweritem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.draweritem/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.draweritem/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.draweritem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.draweritem/#constructor","text":"\u2022 new DrawerItem ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.draweritem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.draweritem/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.draweritem/#props","text":"\u2022 Readonly props : Readonly < DrawerItemProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.draweritem/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.draweritem/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.draweritem/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.draweritem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.draweritem/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.draweritem/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.draweritem/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.draweritem/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.draweritem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.draweritem/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.draweritem/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/","text":"Class: DrawerParamToggler # Renderer . Component .DrawerParamToggler Hierarchy # Component < DrawerParamTogglerProps , State> \u21b3 DrawerParamToggler Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new DrawerParamToggler ( props ) Parameters # Name Type props DrawerParamTogglerProps | Readonly < DrawerParamTogglerProps > Inherited from # React.Component.constructor \u2022 new DrawerParamToggler ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerParamTogglerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerParamTogglerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerParamTogglerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < DrawerParamTogglerProps > prevState Readonly snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerParamTogglerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < DrawerParamTogglerProps > prevState Readonly Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : \"open\" Parameters # Name Type state State | ( prevState : Readonly , props : Readonly < DrawerParamTogglerProps >) => State | Pick | Pick callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#class-drawerparamtoggler","text":"Renderer . Component .DrawerParamToggler","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#hierarchy","text":"Component < DrawerParamTogglerProps , State> \u21b3 DrawerParamToggler","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#constructor","text":"\u2022 new DrawerParamToggler ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#props","text":"\u2022 Readonly props : Readonly < DrawerParamTogglerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#state","text":"\u2022 state : State = {}","title":"state"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.drawerparamtoggler/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/renderer.component.drawertitle/","text":"Class: DrawerTitle # Renderer . Component .DrawerTitle Hierarchy # Component < DrawerTitleProps > \u21b3 DrawerTitle Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new DrawerTitle ( props ) Parameters # Name Type props DrawerTitleProps | Readonly < DrawerTitleProps > Inherited from # React.Component.constructor \u2022 new DrawerTitle ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerTitleProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerTitleProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerTitleProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < DrawerTitleProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < DrawerTitleProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < DrawerTitleProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerTitleProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: DrawerTitle"},{"location":"extensions/api/classes/renderer.component.drawertitle/#class-drawertitle","text":"Renderer . Component .DrawerTitle","title":"Class: DrawerTitle"},{"location":"extensions/api/classes/renderer.component.drawertitle/#hierarchy","text":"Component < DrawerTitleProps > \u21b3 DrawerTitle","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.drawertitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.drawertitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawertitle/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawertitle/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawertitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.drawertitle/#constructor","text":"\u2022 new DrawerTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.drawertitle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.drawertitle/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.drawertitle/#props","text":"\u2022 Readonly props : Readonly < DrawerTitleProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.drawertitle/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.drawertitle/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.drawertitle/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.drawertitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.drawertitle/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawertitle/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawertitle/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.drawertitle/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.drawertitle/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.drawertitle/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.drawertitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.drawertitle/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.drawertitle/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.icon/","text":"Class: Icon # Renderer . Component .Icon Hierarchy # PureComponent < IconProps > \u21b3 Icon Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # isInteractive Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Icon ( props ) Parameters # Name Type props IconProps | Readonly < IconProps > Inherited from # React.PureComponent.constructor \u2022 new Icon ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props IconProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any 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 Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < IconProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : IconProps Accessors # isInteractive # \u2022 get isInteractive (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < IconProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < IconProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < IconProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < IconProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < IconProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Icon"},{"location":"extensions/api/classes/renderer.component.icon/#class-icon","text":"Renderer . Component .Icon","title":"Class: Icon"},{"location":"extensions/api/classes/renderer.component.icon/#hierarchy","text":"PureComponent < IconProps > \u21b3 Icon","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.icon/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.icon/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.icon/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.icon/#accessors","text":"isInteractive","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.icon/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.icon/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.icon/#constructor","text":"\u2022 new Icon ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.icon/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.icon/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.icon/#props","text":"\u2022 Readonly props : Readonly < IconProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.icon/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.icon/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.icon/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.icon/#defaultprops","text":"\u25aa Static defaultProps : IconProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.icon/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.icon/#isinteractive","text":"\u2022 get isInteractive (): boolean","title":"isInteractive"},{"location":"extensions/api/classes/renderer.component.icon/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.icon/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.icon/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.icon/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.icon/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.icon/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.icon/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.icon/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.icon/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.icon/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.icon/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.icon/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.icon/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.icon/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/renderer.component.icon/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.icon/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.icon/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.icon/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.input/","text":"Class: Input # Renderer . Component .Input Hierarchy # Component < InputProps , State> \u21b3 Input Table of contents # Constructors # constructor Properties # context input props refs setDirtyOnChange state validators contextType defaultProps Accessors # isUncontrolled showMaxLenIndicator themeSelection Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef blur componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate getValue onBlur onChange onFocus onKeyDown render select setDirty setState setValidation setValue shouldComponentUpdate validate Constructors # constructor # \u2022 new Input ( props ) Parameters # Name Type props InputProps | Readonly < InputProps > Inherited from # React.Component.constructor \u2022 new Input ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props InputProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context input # \u2022 input : InputElement = null props # \u2022 Readonly props : Readonly < InputProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs setDirtyOnChange # \u2022 setDirtyOnChange : () => void & Cancelable state # \u2022 state : State Overrides # React.Component.state validators # \u2022 validators : InputValidator [] = [] contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isUncontrolled # \u2022 get isUncontrolled (): boolean Returns # boolean showMaxLenIndicator # \u2022 get showMaxLenIndicator (): boolean Returns # boolean themeSelection # \u2022 get themeSelection (): Record Returns # Record Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < InputProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < InputProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem InputElement Returns # void blur # \u25b8 blur (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps InputProps Returns # void Overrides # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < InputProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < InputProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.componentWillUpdate focus # \u25b8 focus (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < InputProps > prevState Readonly Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getValue # \u25b8 getValue (): string Returns # string onBlur # \u25b8 onBlur ( evt ): void Parameters # Name Type evt FocusEvent Returns # void onChange # \u25b8 onChange ( evt ): void Parameters # Name Type evt ChangeEvent Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render select # \u25b8 select (): void Returns # void setDirty # \u25b8 setDirty ( dirty? ): void Parameters # Name Type Default value dirty boolean true Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : keyof State Parameters # Name Type state State | ( prevState : Readonly , props : Readonly < InputProps >) => State | Pick | Pick callback? () => void Returns # void Inherited from # React.Component.setState setValidation # \u25b8 setValidation ( errors ): void Parameters # Name Type errors ReactNode [] Returns # void setValue # \u25b8 setValue ( value? ): void Parameters # Name Type Default value value string \"\" Returns # void shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < InputProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate validate # \u25b8 validate (): Promise Returns # Promise ","title":"Class: Input"},{"location":"extensions/api/classes/renderer.component.input/#class-input","text":"Renderer . Component .Input","title":"Class: Input"},{"location":"extensions/api/classes/renderer.component.input/#hierarchy","text":"Component < InputProps , State> \u21b3 Input","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.input/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.input/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.input/#properties","text":"context input props refs setDirtyOnChange state validators contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.input/#accessors","text":"isUncontrolled showMaxLenIndicator themeSelection","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.input/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef blur componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate getValue onBlur onChange onFocus onKeyDown render select setDirty setState setValidation setValue shouldComponentUpdate validate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.input/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.input/#constructor","text":"\u2022 new Input ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.input/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.input/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.input/#input","text":"\u2022 input : InputElement = null","title":"input"},{"location":"extensions/api/classes/renderer.component.input/#props","text":"\u2022 Readonly props : Readonly < InputProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.input/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.input/#setdirtyonchange","text":"\u2022 setDirtyOnChange : () => void & Cancelable","title":"setDirtyOnChange"},{"location":"extensions/api/classes/renderer.component.input/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/renderer.component.input/#validators","text":"\u2022 validators : InputValidator [] = []","title":"validators"},{"location":"extensions/api/classes/renderer.component.input/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.input/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.input/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.input/#isuncontrolled","text":"\u2022 get isUncontrolled (): boolean","title":"isUncontrolled"},{"location":"extensions/api/classes/renderer.component.input/#showmaxlenindicator","text":"\u2022 get showMaxLenIndicator (): boolean","title":"showMaxLenIndicator"},{"location":"extensions/api/classes/renderer.component.input/#themeselection","text":"\u2022 get themeSelection (): Record ","title":"themeSelection"},{"location":"extensions/api/classes/renderer.component.input/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.input/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.input/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.input/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.input/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.input/#blur","text":"\u25b8 blur (): void","title":"blur"},{"location":"extensions/api/classes/renderer.component.input/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.input/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.input/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.input/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.input/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.input/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.input/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.input/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/renderer.component.input/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.input/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.input/#getvalue","text":"\u25b8 getValue (): string","title":"getValue"},{"location":"extensions/api/classes/renderer.component.input/#onblur","text":"\u25b8 onBlur ( evt ): void","title":"onBlur"},{"location":"extensions/api/classes/renderer.component.input/#onchange","text":"\u25b8 onChange ( evt ): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.input/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/renderer.component.input/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.input/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.input/#select","text":"\u25b8 select (): void","title":"select"},{"location":"extensions/api/classes/renderer.component.input/#setdirty","text":"\u25b8 setDirty ( dirty? ): void","title":"setDirty"},{"location":"extensions/api/classes/renderer.component.input/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.input/#setvalidation","text":"\u25b8 setValidation ( errors ): void","title":"setValidation"},{"location":"extensions/api/classes/renderer.component.input/#setvalue","text":"\u25b8 setValue ( value? ): void","title":"setValue"},{"location":"extensions/api/classes/renderer.component.input/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.input/#validate","text":"\u25b8 validate (): Promise ","title":"validate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/","text":"Class: KubeEventDetails # Renderer . Component .KubeEventDetails Hierarchy # Component < KubeEventDetailsProps > \u21b3 KubeEventDetails Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeEventDetails ( props ) Parameters # Name Type props KubeEventDetailsProps | Readonly < KubeEventDetailsProps > Inherited from # React.Component.constructor \u2022 new KubeEventDetails ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props KubeEventDetailsProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeEventDetailsProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeEventDetailsProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise Returns # Promise Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < KubeEventDetailsProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeEventDetailsProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < KubeEventDetailsProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeEventDetailsProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeEventDetails"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#class-kubeeventdetails","text":"Renderer . Component .KubeEventDetails","title":"Class: KubeEventDetails"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#hierarchy","text":"Component < KubeEventDetailsProps > \u21b3 KubeEventDetails","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#constructor","text":"\u2022 new KubeEventDetails ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#props","text":"\u2022 Readonly props : Readonly < KubeEventDetailsProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentdidmount","text":"\u25b8 componentDidMount (): Promise ","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.kubeeventdetails/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/","text":"Class: KubeObjectDetails # Renderer . Component .KubeObjectDetails Hierarchy # Component \u21b3 KubeObjectDetails Table of contents # Constructors # constructor Properties # context isLoading loader loadingError props refs state contextType Accessors # object path Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectDetails ( props ) Parameters # Name Type props Object Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context isLoading # \u2022 isLoading : boolean = false loader # \u2022 loader : IReactionDisposer loadingError # \u2022 loadingError : ReactNode props # \u2022 Readonly props : Readonly < Object > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Accessors # object # \u2022 get object (): KubeObject Returns # KubeObject path # \u2022 get path (): string Returns # string Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < Object > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < Object > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Object >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectDetails"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#class-kubeobjectdetails","text":"Renderer . Component .KubeObjectDetails","title":"Class: KubeObjectDetails"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#hierarchy","text":"Component \u21b3 KubeObjectDetails","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#properties","text":"context isLoading loader loadingError props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#accessors","text":"object path","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#constructor","text":"\u2022 new KubeObjectDetails ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#loader","text":"\u2022 loader : IReactionDisposer","title":"loader"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#loadingerror","text":"\u2022 loadingError : ReactNode","title":"loadingError"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#props","text":"\u2022 Readonly props : Readonly < Object > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#object","text":"\u2022 get object (): KubeObject ","title":"object"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#path","text":"\u2022 get path (): string","title":"path"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.kubeobjectdetails/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/","text":"Class: KubeObjectListLayout # Renderer . Component .KubeObjectListLayout Type parameters # Name Type K K : KubeObject Hierarchy # Component < KubeObjectListLayoutProps > \u21b3 KubeObjectListLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # selectedItem Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectListLayout ( props ) Type parameters # Name Type K K : KubeObject Parameters # Name Type props KubeObjectListLayoutProps Overrides # React.Component\\>.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectListLayoutProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # selectedItem # \u2022 get selectedItem (): K Returns # K Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectListLayoutProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectListLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < KubeObjectListLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectListLayoutProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectListLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < KubeObjectListLayoutProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectListLayoutProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < KubeObjectListLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectListLayout"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#class-kubeobjectlistlayoutk","text":"Renderer . Component .KubeObjectListLayout","title":"Class: KubeObjectListLayout<K>"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#type-parameters","text":"Name Type K K : KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#hierarchy","text":"Component < KubeObjectListLayoutProps > \u21b3 KubeObjectListLayout","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#accessors","text":"selectedItem","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#constructor","text":"\u2022 new KubeObjectListLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#props","text":"\u2022 Readonly props : Readonly < KubeObjectListLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#selecteditem","text":"\u2022 get selectedItem (): K","title":"selectedItem"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.kubeobjectlistlayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/","text":"Class: KubeObjectMenu # Renderer . Component .KubeObjectMenu Type parameters # Name Type T T : KubeObject Hierarchy # Component < KubeObjectMenuProps > \u21b3 KubeObjectMenu Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # isEditable isRemovable store Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMenuItems getSnapshotBeforeUpdate remove render renderRemoveMessage setState shouldComponentUpdate update Constructors # constructor # \u2022 new KubeObjectMenu ( props ) Type parameters # Name Type T T : KubeObject Parameters # Name Type props KubeObjectMenuProps | Readonly < KubeObjectMenuProps > Inherited from # React.Component>.constructor \u2022 new KubeObjectMenu ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Type parameters # Name Type T T : KubeObject Parameters # Name Type props KubeObjectMenuProps context any Inherited from # React.Component>.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectMenuProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Accessors # isEditable # \u2022 get isEditable (): boolean Returns # boolean isRemovable # \u2022 get isRemovable (): boolean Returns # boolean store # \u2022 get store (): KubeObjectStore < KubeObject > Returns # KubeObjectStore < KubeObject > Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectMenuProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectMenuProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < KubeObjectMenuProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectMenuProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectMenuProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getMenuItems # \u25b8 getMenuItems (): ReactChild [] Returns # ReactChild [] getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < KubeObjectMenuProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate remove # \u25b8 remove (): Promise Returns # Promise render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderRemoveMessage # \u25b8 renderRemoveMessage (): Element Returns # Element setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectMenuProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < KubeObjectMenuProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate update # \u25b8 update (): Promise Returns # Promise ","title":"Class: KubeObjectMenu"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#class-kubeobjectmenut","text":"Renderer . Component .KubeObjectMenu","title":"Class: KubeObjectMenu<T>"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#type-parameters","text":"Name Type T T : KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#hierarchy","text":"Component < KubeObjectMenuProps > \u21b3 KubeObjectMenu","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#accessors","text":"isEditable isRemovable store","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMenuItems getSnapshotBeforeUpdate remove render renderRemoveMessage setState shouldComponentUpdate update","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#constructor","text":"\u2022 new KubeObjectMenu ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#props","text":"\u2022 Readonly props : Readonly < KubeObjectMenuProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#iseditable","text":"\u2022 get isEditable (): boolean","title":"isEditable"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#isremovable","text":"\u2022 get isRemovable (): boolean","title":"isRemovable"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#store","text":"\u2022 get store (): KubeObjectStore < KubeObject >","title":"store"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#getmenuitems","text":"\u25b8 getMenuItems (): ReactChild []","title":"getMenuItems"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#remove","text":"\u25b8 remove (): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#renderremovemessage","text":"\u25b8 renderRemoveMessage (): Element","title":"renderRemoveMessage"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmenu/#update","text":"\u25b8 update (): Promise ","title":"update"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/","text":"Class: KubeObjectMeta # Renderer . Component .KubeObjectMeta Hierarchy # Component < KubeObjectMetaProps > \u21b3 KubeObjectMeta Table of contents # Constructors # constructor Properties # context props refs state contextType defaultHiddenFields Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isHidden render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectMeta ( props ) Parameters # Name Type props KubeObjectMetaProps | Readonly < KubeObjectMetaProps > Inherited from # React.Component.constructor \u2022 new KubeObjectMeta ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props KubeObjectMetaProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectMetaProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultHiddenFields # \u25aa Static defaultHiddenFields : keyof KubeObjectMetadata [] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectMetaProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < KubeObjectMetaProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < KubeObjectMetaProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < KubeObjectMetaProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate isHidden # \u25b8 isHidden ( field ): boolean Parameters # Name Type field keyof KubeObjectMetadata Returns # boolean render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectMetaProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectMeta"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#class-kubeobjectmeta","text":"Renderer . Component .KubeObjectMeta","title":"Class: KubeObjectMeta"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#hierarchy","text":"Component < KubeObjectMetaProps > \u21b3 KubeObjectMeta","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#properties","text":"context props refs state contextType defaultHiddenFields","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isHidden render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#constructor","text":"\u2022 new KubeObjectMeta ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#props","text":"\u2022 Readonly props : Readonly < KubeObjectMetaProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#defaulthiddenfields","text":"\u25aa Static defaultHiddenFields : keyof KubeObjectMetadata []","title":"defaultHiddenFields"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#ishidden","text":"\u25b8 isHidden ( field ): boolean","title":"isHidden"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.kubeobjectmeta/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/","text":"Class: LineProgress # Renderer . Component .LineProgress Hierarchy # PureComponent < LineProgressProps > \u21b3 LineProgress Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new LineProgress ( props ) Parameters # Name Type props LineProgressProps | Readonly < LineProgressProps > Inherited from # React.PureComponent.constructor \u2022 new LineProgress ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props LineProgressProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any 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 Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < LineProgressProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : LineProgressProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < LineProgressProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < LineProgressProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < LineProgressProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < LineProgressProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < LineProgressProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: LineProgress"},{"location":"extensions/api/classes/renderer.component.lineprogress/#class-lineprogress","text":"Renderer . Component .LineProgress","title":"Class: LineProgress"},{"location":"extensions/api/classes/renderer.component.lineprogress/#hierarchy","text":"PureComponent < LineProgressProps > \u21b3 LineProgress","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.lineprogress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.lineprogress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.lineprogress/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.lineprogress/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.lineprogress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.lineprogress/#constructor","text":"\u2022 new LineProgress ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.lineprogress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.lineprogress/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.lineprogress/#props","text":"\u2022 Readonly props : Readonly < LineProgressProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.lineprogress/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.lineprogress/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.lineprogress/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.lineprogress/#defaultprops","text":"\u25aa Static defaultProps : LineProgressProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.lineprogress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.lineprogress/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.lineprogress/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.lineprogress/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.lineprogress/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.lineprogress/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.lineprogress/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.lineprogress/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/","text":"Class: MainLayout # Renderer . Component .MainLayout Main layout is commonly used as a wrapper for \"global pages\" link https://api-docs.k8slens.dev/master/extensions/capabilities/common-capabilities/#global-pages Hierarchy # Component \u21b3 MainLayout Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onSidebarResize render setState shouldComponentUpdate Constructors # constructor # \u2022 new MainLayout ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new MainLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onSidebarResize # \u25b8 onSidebarResize ( width ): void Parameters # Name Type width number Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: MainLayout"},{"location":"extensions/api/classes/renderer.component.mainlayout/#class-mainlayout","text":"Renderer . Component .MainLayout Main layout is commonly used as a wrapper for \"global pages\" link https://api-docs.k8slens.dev/master/extensions/capabilities/common-capabilities/#global-pages","title":"Class: MainLayout"},{"location":"extensions/api/classes/renderer.component.mainlayout/#hierarchy","text":"Component \u21b3 MainLayout","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.mainlayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.mainlayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.mainlayout/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.mainlayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onSidebarResize render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.mainlayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.mainlayout/#constructor","text":"\u2022 new MainLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.mainlayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.mainlayout/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.mainlayout/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.mainlayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.mainlayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.mainlayout/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.mainlayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.mainlayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.mainlayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.mainlayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.mainlayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.mainlayout/#onsidebarresize","text":"\u25b8 onSidebarResize ( width ): void","title":"onSidebarResize"},{"location":"extensions/api/classes/renderer.component.mainlayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.mainlayout/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.mainlayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.menu/","text":"Class: Menu # Renderer . Component .Menu Hierarchy # Component < MenuProps , State> \u21b3 Menu Table of contents # Constructors # constructor Properties # context elem items opener props refs state contextType defaultProps Accessors # focusableItems focusedItem isOpen Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindItemRef bindRef close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focusNextItem forceUpdate getSnapshotBeforeUpdate onBlur onClickOutside onContextMenu onKeyDown onScrollOutside onWindowResize open refreshPosition render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new Menu ( props ) Parameters # Name Type props MenuProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context elem # \u2022 elem : HTMLUListElement items # \u2022 Protected items : Object = {} Index signature # \u25aa [index: number ]: MenuItem opener # \u2022 opener : HTMLElement props # \u2022 Readonly props : Readonly < MenuProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # focusableItems # \u2022 Protected get focusableItems (): MenuItem [] Returns # MenuItem [] focusedItem # \u2022 Protected get focusedItem (): MenuItem Returns # MenuItem isOpen # \u2022 get isOpen (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindItemRef # \u25b8 Protected bindItemRef ( item , index ): void Parameters # Name Type item MenuItem index number Returns # void bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLUListElement Returns # void close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < MenuProps > prevState Readonly snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.componentWillUpdate focusNextItem # \u25b8 Protected focusNextItem ( reverse? ): void Parameters # Name Type Default value reverse boolean false Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < MenuProps > prevState Readonly Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onBlur # \u25b8 onBlur (): void Returns # void onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onContextMenu # \u25b8 onContextMenu (): void Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onScrollOutside # \u25b8 onScrollOutside ( evt ): void Parameters # Name Type evt UIEvent Returns # void onWindowResize # \u25b8 onWindowResize (): void Returns # void open # \u25b8 open (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : \"position\" Parameters # Name Type state State | ( prevState : Readonly , props : Readonly < MenuProps >) => State | Pick | Pick callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < MenuProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: Menu"},{"location":"extensions/api/classes/renderer.component.menu/#class-menu","text":"Renderer . Component .Menu","title":"Class: Menu"},{"location":"extensions/api/classes/renderer.component.menu/#hierarchy","text":"Component < MenuProps , State> \u21b3 Menu","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.menu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.menu/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menu/#properties","text":"context elem items opener props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menu/#accessors","text":"focusableItems focusedItem isOpen","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.menu/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindItemRef bindRef close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focusNextItem forceUpdate getSnapshotBeforeUpdate onBlur onClickOutside onContextMenu onKeyDown onScrollOutside onWindowResize open refreshPosition render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menu/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menu/#constructor","text":"\u2022 new Menu ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.menu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menu/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.menu/#elem","text":"\u2022 elem : HTMLUListElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.menu/#items","text":"\u2022 Protected items : Object = {}","title":"items"},{"location":"extensions/api/classes/renderer.component.menu/#opener","text":"\u2022 opener : HTMLElement","title":"opener"},{"location":"extensions/api/classes/renderer.component.menu/#props","text":"\u2022 Readonly props : Readonly < MenuProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.menu/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.menu/#state","text":"\u2022 state : State = {}","title":"state"},{"location":"extensions/api/classes/renderer.component.menu/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.menu/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.menu/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.menu/#focusableitems","text":"\u2022 Protected get focusableItems (): MenuItem []","title":"focusableItems"},{"location":"extensions/api/classes/renderer.component.menu/#focuseditem","text":"\u2022 Protected get focusedItem (): MenuItem","title":"focusedItem"},{"location":"extensions/api/classes/renderer.component.menu/#isopen","text":"\u2022 get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/renderer.component.menu/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menu/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.menu/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menu/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#binditemref","text":"\u25b8 Protected bindItemRef ( item , index ): void","title":"bindItemRef"},{"location":"extensions/api/classes/renderer.component.menu/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.menu/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/renderer.component.menu/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.menu/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.menu/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.menu/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menu/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.menu/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#focusnextitem","text":"\u25b8 Protected focusNextItem ( reverse? ): void","title":"focusNextItem"},{"location":"extensions/api/classes/renderer.component.menu/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#onblur","text":"\u25b8 onBlur (): void","title":"onBlur"},{"location":"extensions/api/classes/renderer.component.menu/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/renderer.component.menu/#oncontextmenu","text":"\u25b8 onContextMenu (): void","title":"onContextMenu"},{"location":"extensions/api/classes/renderer.component.menu/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.menu/#onscrolloutside","text":"\u25b8 onScrollOutside ( evt ): void","title":"onScrollOutside"},{"location":"extensions/api/classes/renderer.component.menu/#onwindowresize","text":"\u25b8 onWindowResize (): void","title":"onWindowResize"},{"location":"extensions/api/classes/renderer.component.menu/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/classes/renderer.component.menu/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/renderer.component.menu/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.menu/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.menu/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.menu/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/renderer.component.menuactions/","text":"Class: MenuActions # Renderer . Component .MenuActions Hierarchy # Component < MenuActionsProps > \u21b3 MenuActions Table of contents # Constructors # constructor Properties # context id isOpen props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate remove render renderTriggerIcon setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new MenuActions ( props ) Parameters # Name Type props MenuActionsProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context id # \u2022 id : string isOpen # \u2022 isOpen : boolean = !!this.props.toolbar props # \u2022 Readonly props : Readonly < MenuActionsProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : MenuActionsProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuActionsProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < MenuActionsProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuActionsProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < MenuActionsProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate remove # \u25b8 remove (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderTriggerIcon # \u25b8 renderTriggerIcon (): Element Returns # Element setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < MenuActionsProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: MenuActions"},{"location":"extensions/api/classes/renderer.component.menuactions/#class-menuactions","text":"Renderer . Component .MenuActions","title":"Class: MenuActions"},{"location":"extensions/api/classes/renderer.component.menuactions/#hierarchy","text":"Component < MenuActionsProps > \u21b3 MenuActions","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.menuactions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.menuactions/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menuactions/#properties","text":"context id isOpen props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menuactions/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate remove render renderTriggerIcon setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menuactions/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menuactions/#constructor","text":"\u2022 new MenuActions ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.menuactions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menuactions/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.menuactions/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/classes/renderer.component.menuactions/#isopen","text":"\u2022 isOpen : boolean = !!this.props.toolbar","title":"isOpen"},{"location":"extensions/api/classes/renderer.component.menuactions/#props","text":"\u2022 Readonly props : Readonly < MenuActionsProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.menuactions/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.menuactions/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.menuactions/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.menuactions/#defaultprops","text":"\u25aa Static defaultProps : MenuActionsProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.menuactions/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menuactions/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.menuactions/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menuactions/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.menuactions/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#remove","text":"\u25b8 remove (): void","title":"remove"},{"location":"extensions/api/classes/renderer.component.menuactions/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.menuactions/#rendertriggericon","text":"\u25b8 renderTriggerIcon (): Element","title":"renderTriggerIcon"},{"location":"extensions/api/classes/renderer.component.menuactions/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.menuactions/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.menuactions/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/renderer.component.menuitem/","text":"Class: MenuItem # Renderer . Component .MenuItem Hierarchy # Component < MenuItemProps > \u21b3 MenuItem Table of contents # Constructors # constructor Properties # context elem props refs state contextType defaultProps Accessors # isFocusable isLink Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render setState shouldComponentUpdate Constructors # constructor # \u2022 new MenuItem ( props ) Parameters # Name Type props MenuItemProps Overrides # React.Component.constructor Properties # context # \u2022 context : Menu Overrides # React.Component.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < MenuItemProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static contextType : Context < Menu > Overrides # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isFocusable # \u2022 get isFocusable (): boolean Returns # boolean isLink # \u2022 get isLink (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuItemProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < MenuItemProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < MenuItemProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < MenuItemProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < MenuItemProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: MenuItem"},{"location":"extensions/api/classes/renderer.component.menuitem/#class-menuitem","text":"Renderer . Component .MenuItem","title":"Class: MenuItem"},{"location":"extensions/api/classes/renderer.component.menuitem/#hierarchy","text":"Component < MenuItemProps > \u21b3 MenuItem","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.menuitem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.menuitem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menuitem/#properties","text":"context elem props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menuitem/#accessors","text":"isFocusable isLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.menuitem/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menuitem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.menuitem/#constructor","text":"\u2022 new MenuItem ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.menuitem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.menuitem/#context","text":"\u2022 context : Menu","title":"context"},{"location":"extensions/api/classes/renderer.component.menuitem/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.menuitem/#props","text":"\u2022 Readonly props : Readonly < MenuItemProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.menuitem/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.menuitem/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.menuitem/#contexttype","text":"\u25aa Static contextType : Context < Menu >","title":"contextType"},{"location":"extensions/api/classes/renderer.component.menuitem/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.menuitem/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.menuitem/#isfocusable","text":"\u2022 get isFocusable (): boolean","title":"isFocusable"},{"location":"extensions/api/classes/renderer.component.menuitem/#islink","text":"\u2022 get isLink (): boolean","title":"isLink"},{"location":"extensions/api/classes/renderer.component.menuitem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.menuitem/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.menuitem/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menuitem/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menuitem/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.menuitem/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.menuitem/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.menuitem/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.menuitem/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/renderer.component.menuitem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.menuitem/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.menuitem/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/","text":"Class: NamespaceSelect # Renderer . Component .NamespaceSelect Hierarchy # Component \u21b3 NamespaceSelect Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # options Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new NamespaceSelect ( props ) Parameters # Name Type props Props Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # options # \u2022 get options (): SelectOption [] Returns # SelectOption [] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate formatOptionLabel # \u25b8 formatOptionLabel ( option ): Object Parameters # Name Type option SelectOption Returns # Object getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: NamespaceSelect"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#class-namespaceselect","text":"Renderer . Component .NamespaceSelect","title":"Class: NamespaceSelect"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#hierarchy","text":"Component \u21b3 NamespaceSelect","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#accessors","text":"options","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#constructor","text":"\u2022 new NamespaceSelect ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#options","text":"\u2022 get options (): SelectOption []","title":"options"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#formatoptionlabel","text":"\u25b8 formatOptionLabel ( option ): Object","title":"formatOptionLabel"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.namespaceselect/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/","text":"Class: NamespaceSelectFilter # Renderer . Component .NamespaceSelectFilter Hierarchy # Component < SelectProps > \u21b3 NamespaceSelectFilter Table of contents # Constructors # constructor Properties # context props refs state contextType isMenuOpen isMultiSelection Accessors # isMenuOpen isMultiSelection Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate onChange onClick onKeyDown onKeyUp render reset setState shouldComponentUpdate Constructors # constructor # \u2022 new NamespaceSelectFilter ( props ) Parameters # Name Type props SelectProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SelectProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType isMenuOpen # \u25aa Static isMenuOpen : IObservableValue isMultiSelection # \u25aa Static isMultiSelection : IObservableValue Accessors # isMenuOpen # \u2022 get isMenuOpen (): boolean Returns # boolean \u2022 set isMenuOpen ( val ): void Parameters # Name Type val boolean Returns # void isMultiSelection # \u2022 get isMultiSelection (): boolean Returns # boolean \u2022 set isMultiSelection ( val ): void Parameters # Name Type val boolean Returns # void Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SelectProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SelectProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SelectProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate formatOptionLabel # \u25b8 formatOptionLabel ( __namedParameters ): ReactNode Parameters # Name Type __namedParameters SelectOption Returns # ReactNode getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SelectProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onChange # \u25b8 onChange ( __namedParameters ): void Parameters # Name Type __namedParameters SelectOption [] Returns # void onClick # \u25b8 onClick (): void Returns # void onKeyDown # \u25b8 onKeyDown ( e ): void Parameters # Name Type e KeyboardEvent Returns # void onKeyUp # \u25b8 onKeyUp ( e ): void Parameters # Name Type e KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render reset # \u25b8 reset (): void Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SelectProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: NamespaceSelectFilter"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#class-namespaceselectfilter","text":"Renderer . Component .NamespaceSelectFilter","title":"Class: NamespaceSelectFilter"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#hierarchy","text":"Component < SelectProps > \u21b3 NamespaceSelectFilter","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#properties","text":"context props refs state contextType isMenuOpen isMultiSelection","title":"Properties"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#accessors","text":"isMenuOpen isMultiSelection","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate onChange onClick onKeyDown onKeyUp render reset setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#constructor","text":"\u2022 new NamespaceSelectFilter ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#props","text":"\u2022 Readonly props : Readonly < SelectProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#ismenuopen","text":"\u25aa Static isMenuOpen : IObservableValue ","title":"isMenuOpen"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#ismultiselection","text":"\u25aa Static isMultiSelection : IObservableValue ","title":"isMultiSelection"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#ismenuopen_1","text":"\u2022 get isMenuOpen (): boolean","title":"isMenuOpen"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#ismultiselection_1","text":"\u2022 get isMultiSelection (): boolean","title":"isMultiSelection"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#formatoptionlabel","text":"\u25b8 formatOptionLabel ( __namedParameters ): ReactNode","title":"formatOptionLabel"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#onchange","text":"\u25b8 onChange ( __namedParameters ): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#onclick","text":"\u25b8 onClick (): void","title":"onClick"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#onkeydown","text":"\u25b8 onKeyDown ( e ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#onkeyup","text":"\u25b8 onKeyUp ( e ): void","title":"onKeyUp"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.namespaceselectfilter/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/","text":"Class: Notifications # Renderer . Component .Notifications Hierarchy # Component \u21b3 Notifications Table of contents # Constructors # constructor Properties # context elem props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMessage getSnapshotBeforeUpdate render scrollToLastNotification setState shouldComponentUpdate error info ok shortInfo Constructors # constructor # \u2022 new Notifications ( props ) Parameters # Name Type props {} | Readonly < Object > Inherited from # React.Component.constructor \u2022 new Notifications ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Object context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < Object > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < Object > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getMessage # \u25b8 getMessage ( notification ): ( ReactChild | ReactFragment | ReactPortal )[] Parameters # Name Type notification Notification Returns # ( ReactChild | ReactFragment | ReactPortal )[] getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < Object > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render scrollToLastNotification # \u25b8 scrollToLastNotification (): void Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Object >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate error # \u25b8 Static error ( message , customOpts? ): void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # void info # \u25b8 Static info ( message , customOpts? ): () => void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # fn \u25b8 (): void Returns # void ok # \u25b8 Static ok ( message ): void Parameters # Name Type message NotificationMessage Returns # void shortInfo # \u25b8 Static shortInfo ( message , customOpts? ): void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # void","title":"Class: Notifications"},{"location":"extensions/api/classes/renderer.component.notifications/#class-notifications","text":"Renderer . Component .Notifications","title":"Class: Notifications"},{"location":"extensions/api/classes/renderer.component.notifications/#hierarchy","text":"Component \u21b3 Notifications","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.notifications/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.notifications/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.notifications/#properties","text":"context elem props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.notifications/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMessage getSnapshotBeforeUpdate render scrollToLastNotification setState shouldComponentUpdate error info ok shortInfo","title":"Methods"},{"location":"extensions/api/classes/renderer.component.notifications/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.notifications/#constructor","text":"\u2022 new Notifications ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.notifications/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.notifications/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.notifications/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.notifications/#props","text":"\u2022 Readonly props : Readonly < Object > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.notifications/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.notifications/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.notifications/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.notifications/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.notifications/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.notifications/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.notifications/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.notifications/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.notifications/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.notifications/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.notifications/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.notifications/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#getmessage","text":"\u25b8 getMessage ( notification ): ( ReactChild | ReactFragment | ReactPortal )[]","title":"getMessage"},{"location":"extensions/api/classes/renderer.component.notifications/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.notifications/#scrolltolastnotification","text":"\u25b8 scrollToLastNotification (): void","title":"scrollToLastNotification"},{"location":"extensions/api/classes/renderer.component.notifications/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.notifications/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.notifications/#error","text":"\u25b8 Static error ( message , customOpts? ): void","title":"error"},{"location":"extensions/api/classes/renderer.component.notifications/#info","text":"\u25b8 Static info ( message , customOpts? ): () => void","title":"info"},{"location":"extensions/api/classes/renderer.component.notifications/#ok","text":"\u25b8 Static ok ( message ): void","title":"ok"},{"location":"extensions/api/classes/renderer.component.notifications/#shortinfo","text":"\u25b8 Static shortInfo ( message , customOpts? ): void","title":"shortInfo"},{"location":"extensions/api/classes/renderer.component.notificationsstore/","text":"Class: NotificationsStore # Renderer . Component .NotificationsStore Table of contents # Constructors # constructor Properties # autoHideTimers notifications Methods # add addAutoHideTimer getById remove removeAutoHideTimer Constructors # constructor # \u2022 new NotificationsStore () Properties # autoHideTimers # \u2022 Protected autoHideTimers : Map < NotificationId , number> notifications # \u2022 notifications : IObservableArray < Notification > Methods # add # \u25b8 add ( notification ): () => void Parameters # Name Type notification Notification Returns # fn \u25b8 (): void Returns # void addAutoHideTimer # \u25b8 addAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void getById # \u25b8 getById ( id ): Notification Parameters # Name Type id NotificationId Returns # Notification remove # \u25b8 remove ( id ): void Parameters # Name Type id NotificationId Returns # void removeAutoHideTimer # \u25b8 removeAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#class-notificationsstore","text":"Renderer . Component .NotificationsStore","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#properties","text":"autoHideTimers notifications","title":"Properties"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#methods","text":"add addAutoHideTimer getById remove removeAutoHideTimer","title":"Methods"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#constructor","text":"\u2022 new NotificationsStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#autohidetimers","text":"\u2022 Protected autoHideTimers : Map < NotificationId , number>","title":"autoHideTimers"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#notifications","text":"\u2022 notifications : IObservableArray < Notification >","title":"notifications"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#add","text":"\u25b8 add ( notification ): () => void","title":"add"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#addautohidetimer","text":"\u25b8 addAutoHideTimer ( id ): void","title":"addAutoHideTimer"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#getbyid","text":"\u25b8 getById ( id ): Notification","title":"getById"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#remove","text":"\u25b8 remove ( id ): void","title":"remove"},{"location":"extensions/api/classes/renderer.component.notificationsstore/#removeautohidetimer","text":"\u25b8 removeAutoHideTimer ( id ): void","title":"removeAutoHideTimer"},{"location":"extensions/api/classes/renderer.component.pagelayout/","text":"Class: PageLayout # Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout deprecated Hierarchy # SettingLayout \u21b3 PageLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate back componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate Constructors # constructor # \u2022 new PageLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # SettingLayout . constructor \u2022 new PageLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # SettingLayout . constructor Properties # context # \u2022 context : any 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 Inherited from # SettingLayout . context props # \u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object > Inherited from # SettingLayout . props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # SettingLayout . refs state # \u2022 state : Readonly < Object > Inherited from # SettingLayout . state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # SettingLayout . contextType defaultProps # \u25aa Static defaultProps : object Inherited from # SettingLayout . defaultProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # SettingLayout . UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # SettingLayout . UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # SettingLayout . UNSAFE_componentWillUpdate back # \u25b8 back ( evt? ): void Parameters # Name Type evt? MouseEvent | KeyboardEvent Returns # void Inherited from # SettingLayout . back componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # SettingLayout . componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise Returns # Promise Inherited from # SettingLayout . componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # SettingLayout . componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # SettingLayout . componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # SettingLayout . componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Inherited from # SettingLayout . componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # SettingLayout . componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # SettingLayout . forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > Returns # any Inherited from # SettingLayout . getSnapshotBeforeUpdate onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void Inherited from # SettingLayout . onEscapeKey render # \u25b8 render (): Element Returns # Element Inherited from # SettingLayout . render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SettingLayoutProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # SettingLayout . setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # SettingLayout . shouldComponentUpdate","title":"Class: PageLayout"},{"location":"extensions/api/classes/renderer.component.pagelayout/#class-pagelayout","text":"Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout deprecated","title":"Class: PageLayout"},{"location":"extensions/api/classes/renderer.component.pagelayout/#hierarchy","text":"SettingLayout \u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.pagelayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.pagelayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.pagelayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.pagelayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate back componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.pagelayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.pagelayout/#constructor","text":"\u2022 new PageLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.pagelayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.pagelayout/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.pagelayout/#props","text":"\u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.pagelayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.pagelayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.pagelayout/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.pagelayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.pagelayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.pagelayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.pagelayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.pagelayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.pagelayout/#back","text":"\u25b8 back ( evt? ): void","title":"back"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise ","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.pagelayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.pagelayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.pagelayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.pagelayout/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/renderer.component.pagelayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.pagelayout/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.pagelayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/","text":"Class: PieChart # Renderer . Component .PieChart Hierarchy # Component \u21b3 PieChart Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new PieChart ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new PieChart ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: PieChart"},{"location":"extensions/api/classes/renderer.component.piechart/#class-piechart","text":"Renderer . Component .PieChart","title":"Class: PieChart"},{"location":"extensions/api/classes/renderer.component.piechart/#hierarchy","text":"Component \u21b3 PieChart","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.piechart/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.piechart/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.piechart/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.piechart/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.piechart/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.piechart/#constructor","text":"\u2022 new PieChart ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.piechart/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.piechart/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.piechart/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.piechart/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.piechart/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.piechart/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.piechart/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.piechart/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.piechart/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.piechart/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.piechart/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.piechart/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.piechart/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.piechart/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.piechart/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.piechart/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.piechart/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.piechart/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/","text":"Class: PodDetailsList # Renderer . Component .PodDetailsList Hierarchy # Component \u21b3 PodDetailsList Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getTableRow render renderCpuUsage renderMemoryUsage setState shouldComponentUpdate Constructors # constructor # \u2022 new PodDetailsList ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new PodDetailsList ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : OptionalProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getTableRow # \u25b8 getTableRow ( uid ): Element Parameters # Name Type uid string Returns # Element render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCpuUsage # \u25b8 renderCpuUsage ( id , usage ): string | 0 | Element Parameters # Name Type id string usage number Returns # string | 0 | Element renderMemoryUsage # \u25b8 renderMemoryUsage ( id , usage ): string | 0 | Element Parameters # Name Type id string usage number Returns # string | 0 | Element setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: PodDetailsList"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#class-poddetailslist","text":"Renderer . Component .PodDetailsList","title":"Class: PodDetailsList"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#hierarchy","text":"Component \u21b3 PodDetailsList","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getTableRow render renderCpuUsage renderMemoryUsage setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#constructor","text":"\u2022 new PodDetailsList ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#defaultprops","text":"\u25aa Static defaultProps : OptionalProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#gettablerow","text":"\u25b8 getTableRow ( uid ): Element","title":"getTableRow"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#rendercpuusage","text":"\u25b8 renderCpuUsage ( id , usage ): string | 0 | Element","title":"renderCpuUsage"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#rendermemoryusage","text":"\u25b8 renderMemoryUsage ( id , usage ): string | 0 | Element","title":"renderMemoryUsage"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.poddetailslist/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.radio/","text":"Class: Radio # Renderer . Component .Radio Hierarchy # Component < RadioProps > \u21b3 Radio Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onChange onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Radio ( props ) Parameters # Name Type props RadioProps | Readonly < RadioProps > Inherited from # React.Component.constructor \u2022 new Radio ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props RadioProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < RadioProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < RadioProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < RadioProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < RadioProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < RadioProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onChange # \u25b8 onChange (): void Returns # void onKeyDown # \u25b8 onKeyDown ( e ): void Parameters # Name Type e KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < RadioProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Radio"},{"location":"extensions/api/classes/renderer.component.radio/#class-radio","text":"Renderer . Component .Radio","title":"Class: Radio"},{"location":"extensions/api/classes/renderer.component.radio/#hierarchy","text":"Component < RadioProps > \u21b3 Radio","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.radio/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.radio/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.radio/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.radio/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onChange onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.radio/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.radio/#constructor","text":"\u2022 new Radio ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.radio/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.radio/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.radio/#props","text":"\u2022 Readonly props : Readonly < RadioProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.radio/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.radio/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.radio/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.radio/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.radio/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.radio/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.radio/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.radio/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.radio/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.radio/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.radio/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.radio/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.radio/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.radio/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.radio/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.radio/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.radio/#onchange","text":"\u25b8 onChange (): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.radio/#onkeydown","text":"\u25b8 onKeyDown ( e ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.radio/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.radio/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.radio/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/","text":"Class: RadioGroup # Renderer . Component .RadioGroup Hierarchy # Component < RadioGroupProps , Object > \u21b3 RadioGroup Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new RadioGroup ( props ) Parameters # Name Type props RadioGroupProps | Readonly < RadioGroupProps > Inherited from # React.Component.constructor \u2022 new RadioGroup ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props RadioGroupProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < RadioGroupProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < RadioGroupProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < RadioGroupProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < RadioGroupProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < RadioGroupProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < RadioGroupProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: RadioGroup"},{"location":"extensions/api/classes/renderer.component.radiogroup/#class-radiogroup","text":"Renderer . Component .RadioGroup","title":"Class: RadioGroup"},{"location":"extensions/api/classes/renderer.component.radiogroup/#hierarchy","text":"Component < RadioGroupProps , Object > \u21b3 RadioGroup","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.radiogroup/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.radiogroup/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.radiogroup/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.radiogroup/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.radiogroup/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.radiogroup/#constructor","text":"\u2022 new RadioGroup ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.radiogroup/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.radiogroup/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.radiogroup/#props","text":"\u2022 Readonly props : Readonly < RadioGroupProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.radiogroup/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.radiogroup/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.radiogroup/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.radiogroup/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.radiogroup/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.radiogroup/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.radiogroup/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.radiogroup/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.radiogroup/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.radiogroup/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.radiogroup/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/","text":"Class: SearchInput # Renderer . Component .SearchInput Hierarchy # Component \u21b3 SearchInput Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate clear componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onGlobalKey onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new SearchInput ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new SearchInput ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate clear # \u25b8 clear (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onGlobalKey # \u25b8 onGlobalKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SearchInput"},{"location":"extensions/api/classes/renderer.component.searchinput/#class-searchinput","text":"Renderer . Component .SearchInput","title":"Class: SearchInput"},{"location":"extensions/api/classes/renderer.component.searchinput/#hierarchy","text":"Component \u21b3 SearchInput","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.searchinput/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.searchinput/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.searchinput/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.searchinput/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate clear componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onGlobalKey onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.searchinput/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.searchinput/#constructor","text":"\u2022 new SearchInput ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.searchinput/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.searchinput/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.searchinput/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.searchinput/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.searchinput/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.searchinput/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.searchinput/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.searchinput/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.searchinput/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.searchinput/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.searchinput/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/#clear","text":"\u25b8 clear (): void","title":"clear"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.searchinput/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.searchinput/#onglobalkey","text":"\u25b8 onGlobalKey ( evt ): void","title":"onGlobalKey"},{"location":"extensions/api/classes/renderer.component.searchinput/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.searchinput/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.searchinput/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.searchinput/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.select/","text":"Class: Select # Renderer . Component .Select Hierarchy # Component < SelectProps > \u21b3 Select Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # options selectedOption themeClass Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isValidOption onChange onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Select ( props ) Parameters # Name Type props SelectProps Overrides # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SelectProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : SelectProps Accessors # options # \u2022 get options (): SelectOption [] Returns # SelectOption [] selectedOption # \u2022 get selectedOption (): SelectOption | SelectOption [] Returns # SelectOption | SelectOption [] themeClass # \u2022 get themeClass (): string Returns # string Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SelectProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SelectProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SelectProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SelectProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate isValidOption # \u25b8 Protected isValidOption ( opt ): boolean Parameters # Name Type opt any Returns # boolean onChange # \u25b8 onChange ( value , meta ): void Parameters # Name Type value SelectOption meta ActionMeta Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SelectProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SelectProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Select"},{"location":"extensions/api/classes/renderer.component.select/#class-select","text":"Renderer . Component .Select","title":"Class: Select"},{"location":"extensions/api/classes/renderer.component.select/#hierarchy","text":"Component < SelectProps > \u21b3 Select","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.select/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.select/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.select/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.select/#accessors","text":"options selectedOption themeClass","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.select/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isValidOption onChange onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.select/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.select/#constructor","text":"\u2022 new Select ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.select/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.select/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.select/#props","text":"\u2022 Readonly props : Readonly < SelectProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.select/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.select/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.select/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.select/#defaultprops","text":"\u25aa Static defaultProps : SelectProps ","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.select/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.select/#options","text":"\u2022 get options (): SelectOption []","title":"options"},{"location":"extensions/api/classes/renderer.component.select/#selectedoption","text":"\u2022 get selectedOption (): SelectOption | SelectOption []","title":"selectedOption"},{"location":"extensions/api/classes/renderer.component.select/#themeclass","text":"\u2022 get themeClass (): string","title":"themeClass"},{"location":"extensions/api/classes/renderer.component.select/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.select/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.select/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.select/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.select/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.select/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.select/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.select/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.select/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.select/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.select/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.select/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.select/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.select/#isvalidoption","text":"\u25b8 Protected isValidOption ( opt ): boolean","title":"isValidOption"},{"location":"extensions/api/classes/renderer.component.select/#onchange","text":"\u25b8 onChange ( value , meta ): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.select/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.select/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.select/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.select/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/","text":"Class: SettingLayout # Renderer . Component .SettingLayout Layout for settings like pages with navigation Hierarchy # Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate back componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate Constructors # constructor # \u2022 new SettingLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # React.Component.constructor \u2022 new SettingLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate back # \u25b8 back ( evt? ): void Parameters # Name Type evt? MouseEvent | KeyboardEvent Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise Returns # Promise Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SettingLayoutProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SettingLayout"},{"location":"extensions/api/classes/renderer.component.settinglayout/#class-settinglayout","text":"Renderer . Component .SettingLayout Layout for settings like pages with navigation","title":"Class: SettingLayout"},{"location":"extensions/api/classes/renderer.component.settinglayout/#hierarchy","text":"Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.settinglayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.settinglayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.settinglayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.settinglayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate back componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.settinglayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.settinglayout/#constructor","text":"\u2022 new SettingLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.settinglayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.settinglayout/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.settinglayout/#props","text":"\u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.settinglayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.settinglayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.settinglayout/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.settinglayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.settinglayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.settinglayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.settinglayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.settinglayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/#back","text":"\u25b8 back ( evt? ): void","title":"back"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise ","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.settinglayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.settinglayout/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/renderer.component.settinglayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.settinglayout/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.settinglayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.slider/","text":"Class: Slider # Renderer . Component .Slider Hierarchy # Component < SliderProps > \u21b3 Slider Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Slider ( props ) Parameters # Name Type props SliderProps | Readonly < SliderProps > Inherited from # Component.constructor \u2022 new Slider ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SliderProps context any Inherited from # Component.constructor Properties # context # \u2022 context : any 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 Inherited from # Component.context props # \u2022 Readonly props : Readonly < SliderProps > & Readonly < Object > Inherited from # Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # Component.refs state # \u2022 state : Readonly < Object > Inherited from # Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SliderProps > nextContext any Returns # void Inherited from # Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SliderProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SliderProps > nextContext any Returns # void Inherited from # Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SliderProps > prevState Readonly < Object > Returns # any Inherited from # Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SliderProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # Component.shouldComponentUpdate","title":"Class: Slider"},{"location":"extensions/api/classes/renderer.component.slider/#class-slider","text":"Renderer . Component .Slider","title":"Class: Slider"},{"location":"extensions/api/classes/renderer.component.slider/#hierarchy","text":"Component < SliderProps > \u21b3 Slider","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.slider/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.slider/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.slider/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.slider/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.slider/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.slider/#constructor","text":"\u2022 new Slider ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.slider/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.slider/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.slider/#props","text":"\u2022 Readonly props : Readonly < SliderProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.slider/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.slider/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.slider/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.slider/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.slider/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.slider/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.slider/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.slider/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.slider/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.slider/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.slider/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.slider/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.slider/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.slider/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.slider/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.slider/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.slider/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.slider/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.slider/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.slider/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/","text":"Class: Spinner # Renderer . Component .Spinner Hierarchy # Component < SpinnerProps , Object > \u21b3 Spinner Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Spinner ( props ) Parameters # Name Type props SpinnerProps | Readonly < SpinnerProps > Inherited from # React.Component.constructor \u2022 new Spinner ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SpinnerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SpinnerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : Object Type declaration # Name Type center boolean singleColor boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SpinnerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < SpinnerProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < SpinnerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < SpinnerProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SpinnerProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Spinner"},{"location":"extensions/api/classes/renderer.component.spinner/#class-spinner","text":"Renderer . Component .Spinner","title":"Class: Spinner"},{"location":"extensions/api/classes/renderer.component.spinner/#hierarchy","text":"Component < SpinnerProps , Object > \u21b3 Spinner","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.spinner/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.spinner/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.spinner/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.spinner/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.spinner/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.spinner/#constructor","text":"\u2022 new Spinner ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.spinner/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.spinner/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.spinner/#props","text":"\u2022 Readonly props : Readonly < SpinnerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.spinner/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.spinner/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.spinner/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.spinner/#defaultprops","text":"\u25aa Static defaultProps : Object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.spinner/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.spinner/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.spinner/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.spinner/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.spinner/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.spinner/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.spinner/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.spinner/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.spinner/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.spinner/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.spinner/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.spinner/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/","text":"Class: StatusBrick # Renderer . Component .StatusBrick Hierarchy # Component < StatusBrickProps > \u21b3 StatusBrick Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new StatusBrick ( props ) Parameters # Name Type props StatusBrickProps | Readonly < StatusBrickProps > Inherited from # React.Component.constructor \u2022 new StatusBrick ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StatusBrickProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < StatusBrickProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < StatusBrickProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < StatusBrickProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < StatusBrickProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < StatusBrickProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < StatusBrickProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: StatusBrick"},{"location":"extensions/api/classes/renderer.component.statusbrick/#class-statusbrick","text":"Renderer . Component .StatusBrick","title":"Class: StatusBrick"},{"location":"extensions/api/classes/renderer.component.statusbrick/#hierarchy","text":"Component < StatusBrickProps > \u21b3 StatusBrick","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.statusbrick/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.statusbrick/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.statusbrick/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.statusbrick/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.statusbrick/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.statusbrick/#constructor","text":"\u2022 new StatusBrick ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.statusbrick/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.statusbrick/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.statusbrick/#props","text":"\u2022 Readonly props : Readonly < StatusBrickProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.statusbrick/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.statusbrick/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.statusbrick/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.statusbrick/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.statusbrick/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.statusbrick/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.statusbrick/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.statusbrick/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.statusbrick/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.statusbrick/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.statusbrick/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/","text":"Class: Stepper # Renderer . Component .Stepper Hierarchy # Component < StepperProps , Object > \u21b3 Stepper Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Stepper ( props ) Parameters # Name Type props StepperProps | Readonly < StepperProps > Inherited from # React.Component.constructor \u2022 new Stepper ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StepperProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < StepperProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < StepperProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < StepperProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < StepperProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < StepperProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < StepperProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Stepper"},{"location":"extensions/api/classes/renderer.component.stepper/#class-stepper","text":"Renderer . Component .Stepper","title":"Class: Stepper"},{"location":"extensions/api/classes/renderer.component.stepper/#hierarchy","text":"Component < StepperProps , Object > \u21b3 Stepper","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.stepper/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.stepper/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.stepper/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.stepper/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.stepper/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.stepper/#constructor","text":"\u2022 new Stepper ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.stepper/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.stepper/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.stepper/#props","text":"\u2022 Readonly props : Readonly < StepperProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.stepper/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.stepper/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.stepper/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.stepper/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.stepper/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.stepper/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.stepper/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.stepper/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.stepper/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.stepper/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.stepper/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.stepper/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.stepper/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.stepper/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.stepper/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/","text":"Class: SubTitle # Renderer . Component .SubTitle Hierarchy # Component \u21b3 SubTitle Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new SubTitle ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new SubTitle ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SubTitle"},{"location":"extensions/api/classes/renderer.component.subtitle/#class-subtitle","text":"Renderer . Component .SubTitle","title":"Class: SubTitle"},{"location":"extensions/api/classes/renderer.component.subtitle/#hierarchy","text":"Component \u21b3 SubTitle","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.subtitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.subtitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.subtitle/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.subtitle/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.subtitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.subtitle/#constructor","text":"\u2022 new SubTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.subtitle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.subtitle/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.subtitle/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.subtitle/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.subtitle/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.subtitle/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.subtitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.subtitle/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.subtitle/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.subtitle/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.subtitle/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.subtitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.subtitle/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.subtitle/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.tab/","text":"Class: Tab # Renderer . Component .Tab Hierarchy # PureComponent < TabProps > \u21b3 Tab Table of contents # Constructors # constructor Properties # context props ref refs state contextType Accessors # isActive Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate onClick onFocus onKeyDown render scrollIntoView setState shouldComponentUpdate Constructors # constructor # \u2022 new Tab ( props ) Parameters # Name Type props TabProps | Readonly < TabProps > Inherited from # React.PureComponent.constructor \u2022 new Tab ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TabProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : TabsContextValue Overrides # React.PureComponent.context props # \u2022 Readonly props : Readonly < TabProps > & Readonly < Object > Inherited from # React.PureComponent.props ref # \u2022 ref : RefObject refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static contextType : Context > Overrides # React.PureComponent.contextType Accessors # isActive # \u2022 get isActive (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TabProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TabProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TabProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TabProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TabProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate focus # \u25b8 focus (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TabProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render scrollIntoView # \u25b8 scrollIntoView (): void Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TabProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TabProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Tab"},{"location":"extensions/api/classes/renderer.component.tab/#class-tab","text":"Renderer . Component .Tab","title":"Class: Tab"},{"location":"extensions/api/classes/renderer.component.tab/#hierarchy","text":"PureComponent < TabProps > \u21b3 Tab","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tab/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tab/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tab/#properties","text":"context props ref refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tab/#accessors","text":"isActive","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tab/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate onClick onFocus onKeyDown render scrollIntoView setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tab/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tab/#constructor","text":"\u2022 new Tab ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tab/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tab/#context","text":"\u2022 context : TabsContextValue ","title":"context"},{"location":"extensions/api/classes/renderer.component.tab/#props","text":"\u2022 Readonly props : Readonly < TabProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tab/#ref","text":"\u2022 ref : RefObject ","title":"ref"},{"location":"extensions/api/classes/renderer.component.tab/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tab/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tab/#contexttype","text":"\u25aa Static contextType : Context >","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tab/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tab/#isactive","text":"\u2022 get isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/renderer.component.tab/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tab/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tab/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tab/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tab/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tab/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tab/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tab/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tab/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tab/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tab/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tab/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/renderer.component.tab/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tab/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tab/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/renderer.component.tab/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/renderer.component.tab/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/renderer.component.tab/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tab/#scrollintoview","text":"\u25b8 scrollIntoView (): void","title":"scrollIntoView"},{"location":"extensions/api/classes/renderer.component.tab/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tab/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.table/","text":"Class: Table # Renderer . Component .Table Type parameters # Name Item Hierarchy # Component < TableProps > \u21b3 Table Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # sortParams Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getSorted onSort render renderHead renderRows setState shouldComponentUpdate sort Constructors # constructor # \u2022 new Table ( props ) Type parameters # Name Item Parameters # Name Type props TableProps Overrides # React.Component\\>.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : TableProps Accessors # sortParams # \u2022 get sortParams (): Partial < TableSortParams > Returns # Partial < TableSortParams > Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TableProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TableProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getSorted # \u25b8 getSorted ( items ): any [] Parameters # Name Type items any [] Returns # any [] onSort # \u25b8 Protected onSort ( __namedParameters ): void Parameters # Name Type __namedParameters TableSortParams Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderHead # \u25b8 renderHead (): ReactElement < TableHeadProps , string | JSXElementConstructor> Returns # ReactElement < TableHeadProps , string | JSXElementConstructor> renderRows # \u25b8 renderRows (): Object Returns # Object setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TableProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate sort # \u25b8 sort ( colName ): void Parameters # Name Type colName string Returns # void","title":"Class: Table"},{"location":"extensions/api/classes/renderer.component.table/#class-tableitem","text":"Renderer . Component .Table","title":"Class: Table<Item>"},{"location":"extensions/api/classes/renderer.component.table/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/classes/renderer.component.table/#hierarchy","text":"Component < TableProps > \u21b3 Table","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.table/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.table/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.table/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.table/#accessors","text":"sortParams","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.table/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getSorted onSort render renderHead renderRows setState shouldComponentUpdate sort","title":"Methods"},{"location":"extensions/api/classes/renderer.component.table/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.table/#constructor","text":"\u2022 new Table ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.table/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.table/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.table/#props","text":"\u2022 Readonly props : Readonly < TableProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.table/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.table/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.table/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.table/#defaultprops","text":"\u25aa Static defaultProps : TableProps ","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.table/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.table/#sortparams","text":"\u2022 get sortParams (): Partial < TableSortParams >","title":"sortParams"},{"location":"extensions/api/classes/renderer.component.table/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.table/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.table/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.table/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.table/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.table/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.table/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.table/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.table/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.table/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.table/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.table/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.table/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.table/#getsorted","text":"\u25b8 getSorted ( items ): any []","title":"getSorted"},{"location":"extensions/api/classes/renderer.component.table/#onsort","text":"\u25b8 Protected onSort ( __namedParameters ): void","title":"onSort"},{"location":"extensions/api/classes/renderer.component.table/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.table/#renderhead","text":"\u25b8 renderHead (): ReactElement < TableHeadProps , string | JSXElementConstructor>","title":"renderHead"},{"location":"extensions/api/classes/renderer.component.table/#renderrows","text":"\u25b8 renderRows (): Object","title":"renderRows"},{"location":"extensions/api/classes/renderer.component.table/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.table/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.table/#sort","text":"\u25b8 sort ( colName ): void","title":"sort"},{"location":"extensions/api/classes/renderer.component.tablecell/","text":"Class: TableCell # Renderer . Component .TableCell Hierarchy # Component < TableCellProps > \u21b3 TableCell Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # isSortable Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render renderCheckbox renderSortIcon setState shouldComponentUpdate Constructors # constructor # \u2022 new TableCell ( props ) Parameters # Name Type props TableCellProps | Readonly < TableCellProps > Inherited from # React.Component.constructor \u2022 new TableCell ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableCellProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableCellProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Accessors # isSortable # \u2022 get isSortable (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableCellProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TableCellProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableCellProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TableCellProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCheckbox # \u25b8 renderCheckbox (): Element Returns # Element renderSortIcon # \u25b8 renderSortIcon (): Element Returns # Element setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableCellProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableCell"},{"location":"extensions/api/classes/renderer.component.tablecell/#class-tablecell","text":"Renderer . Component .TableCell","title":"Class: TableCell"},{"location":"extensions/api/classes/renderer.component.tablecell/#hierarchy","text":"Component < TableCellProps > \u21b3 TableCell","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tablecell/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tablecell/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablecell/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablecell/#accessors","text":"isSortable","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tablecell/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render renderCheckbox renderSortIcon setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablecell/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablecell/#constructor","text":"\u2022 new TableCell ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tablecell/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablecell/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.tablecell/#props","text":"\u2022 Readonly props : Readonly < TableCellProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tablecell/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tablecell/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tablecell/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tablecell/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tablecell/#issortable","text":"\u2022 get isSortable (): boolean","title":"isSortable"},{"location":"extensions/api/classes/renderer.component.tablecell/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablecell/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablecell/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablecell/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tablecell/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablecell/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tablecell/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tablecell/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/renderer.component.tablecell/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tablecell/#rendercheckbox","text":"\u25b8 renderCheckbox (): Element","title":"renderCheckbox"},{"location":"extensions/api/classes/renderer.component.tablecell/#rendersorticon","text":"\u25b8 renderSortIcon (): Element","title":"renderSortIcon"},{"location":"extensions/api/classes/renderer.component.tablecell/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tablecell/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/","text":"Class: TableHead # Renderer . Component .TableHead Hierarchy # Component < TableHeadProps > \u21b3 TableHead Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new TableHead ( props ) Parameters # Name Type props TableHeadProps | Readonly < TableHeadProps > Inherited from # React.Component.constructor \u2022 new TableHead ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableHeadProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableHeadProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : TableHeadProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableHeadProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TableHeadProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableHeadProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TableHeadProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableHeadProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableHead"},{"location":"extensions/api/classes/renderer.component.tablehead/#class-tablehead","text":"Renderer . Component .TableHead","title":"Class: TableHead"},{"location":"extensions/api/classes/renderer.component.tablehead/#hierarchy","text":"Component < TableHeadProps > \u21b3 TableHead","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tablehead/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tablehead/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablehead/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablehead/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablehead/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablehead/#constructor","text":"\u2022 new TableHead ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tablehead/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablehead/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.tablehead/#props","text":"\u2022 Readonly props : Readonly < TableHeadProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tablehead/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tablehead/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tablehead/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tablehead/#defaultprops","text":"\u25aa Static defaultProps : TableHeadProps","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.tablehead/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablehead/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablehead/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablehead/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tablehead/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tablehead/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tablehead/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tablehead/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/","text":"Class: TableRow # Renderer . Component .TableRow Hierarchy # Component < TableRowProps > \u21b3 TableRow Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new TableRow ( props ) Parameters # Name Type props TableRowProps | Readonly < TableRowProps > Inherited from # React.Component.constructor \u2022 new TableRow ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableRowProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableRowProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableRowProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TableRowProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TableRowProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TableRowProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableRowProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableRow"},{"location":"extensions/api/classes/renderer.component.tablerow/#class-tablerow","text":"Renderer . Component .TableRow","title":"Class: TableRow"},{"location":"extensions/api/classes/renderer.component.tablerow/#hierarchy","text":"Component < TableRowProps > \u21b3 TableRow","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tablerow/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tablerow/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablerow/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablerow/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablerow/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tablerow/#constructor","text":"\u2022 new TableRow ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tablerow/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tablerow/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.tablerow/#props","text":"\u2022 Readonly props : Readonly < TableRowProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tablerow/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tablerow/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tablerow/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tablerow/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tablerow/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablerow/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablerow/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tablerow/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tablerow/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tablerow/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tablerow/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/","text":"Class: Tabs # Renderer . Component .Tabs Hierarchy # PureComponent < TabsProps > \u21b3 Tabs Table of contents # Constructors # constructor Properties # context elem props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Tabs ( props ) Parameters # Name Type props TabsProps | Readonly < TabsProps > Inherited from # React.PureComponent.constructor \u2022 new Tabs ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TabsProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any 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 Inherited from # React.PureComponent.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < TabsProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TabsProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TabsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TabsProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TabsProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TabsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TabsProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TabsProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TabsProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Tabs"},{"location":"extensions/api/classes/renderer.component.tabs/#class-tabs","text":"Renderer . Component .Tabs","title":"Class: Tabs"},{"location":"extensions/api/classes/renderer.component.tabs/#hierarchy","text":"PureComponent < TabsProps > \u21b3 Tabs","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tabs/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tabs/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tabs/#properties","text":"context elem props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tabs/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tabs/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tabs/#constructor","text":"\u2022 new Tabs ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tabs/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tabs/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.tabs/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.tabs/#props","text":"\u2022 Readonly props : Readonly < TabsProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tabs/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tabs/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tabs/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tabs/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tabs/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tabs/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tabs/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.tabs/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tabs/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tabs/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tabs/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tabs/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tabs/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tabs/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tabs/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tabs/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.terminalstore/","text":"Class: TerminalStore # Renderer . Component .TerminalStore Hierarchy # Singleton \u21b3 TerminalStore Table of contents # Constructors # constructor Properties # connections terminals Methods # connect disconnect getTerminal isConnected isDisconnected reconnect reset sendCommand createInstance getInstance resetInstance Constructors # constructor # \u2022 new TerminalStore () Overrides # Singleton . constructor Properties # connections # \u2022 Protected connections : ObservableMap terminals # \u2022 Protected terminals : Map Methods # connect # \u25b8 connect ( tabId ): void Parameters # Name Type tabId string Returns # void disconnect # \u25b8 disconnect ( tabId ): void Parameters # Name Type tabId string Returns # void getTerminal # \u25b8 getTerminal ( tabId ): Terminal Parameters # Name Type tabId string Returns # Terminal isConnected # \u25b8 isConnected ( tabId ): boolean Parameters # Name Type tabId string Returns # boolean isDisconnected # \u25b8 isDisconnected ( tabId ): boolean Parameters # Name Type tabId string Returns # boolean reconnect # \u25b8 reconnect ( tabId ): void Parameters # Name Type tabId string Returns # void reset # \u25b8 reset (): void Returns # void sendCommand # \u25b8 sendCommand ( command , options? ): Promise Parameters # Name Type command string options Object options.enter? boolean options.newTab? boolean options.tabId? string Returns # Promise createInstance # \u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # Singleton . createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # Singleton . getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # Singleton . resetInstance","title":"Class: TerminalStore"},{"location":"extensions/api/classes/renderer.component.terminalstore/#class-terminalstore","text":"Renderer . Component .TerminalStore","title":"Class: TerminalStore"},{"location":"extensions/api/classes/renderer.component.terminalstore/#hierarchy","text":"Singleton \u21b3 TerminalStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.terminalstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.terminalstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.terminalstore/#properties","text":"connections terminals","title":"Properties"},{"location":"extensions/api/classes/renderer.component.terminalstore/#methods","text":"connect disconnect getTerminal isConnected isDisconnected reconnect reset sendCommand createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/renderer.component.terminalstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.terminalstore/#constructor","text":"\u2022 new TerminalStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.component.terminalstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.terminalstore/#connections","text":"\u2022 Protected connections : ObservableMap ","title":"connections"},{"location":"extensions/api/classes/renderer.component.terminalstore/#terminals","text":"\u2022 Protected terminals : Map ","title":"terminals"},{"location":"extensions/api/classes/renderer.component.terminalstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.terminalstore/#connect","text":"\u25b8 connect ( tabId ): void","title":"connect"},{"location":"extensions/api/classes/renderer.component.terminalstore/#disconnect","text":"\u25b8 disconnect ( tabId ): void","title":"disconnect"},{"location":"extensions/api/classes/renderer.component.terminalstore/#getterminal","text":"\u25b8 getTerminal ( tabId ): Terminal","title":"getTerminal"},{"location":"extensions/api/classes/renderer.component.terminalstore/#isconnected","text":"\u25b8 isConnected ( tabId ): boolean","title":"isConnected"},{"location":"extensions/api/classes/renderer.component.terminalstore/#isdisconnected","text":"\u25b8 isDisconnected ( tabId ): boolean","title":"isDisconnected"},{"location":"extensions/api/classes/renderer.component.terminalstore/#reconnect","text":"\u25b8 reconnect ( tabId ): void","title":"reconnect"},{"location":"extensions/api/classes/renderer.component.terminalstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.component.terminalstore/#sendcommand","text":"\u25b8 sendCommand ( command , options? ): Promise ","title":"sendCommand"},{"location":"extensions/api/classes/renderer.component.terminalstore/#createinstance","text":"\u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/renderer.component.terminalstore/#getinstance","text":"\u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/renderer.component.terminalstore/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/renderer.component.tooltip/","text":"Class: Tooltip # Renderer . Component .Tooltip Hierarchy # Component < TooltipProps > \u21b3 Tooltip Table of contents # Constructors # constructor Properties # activePosition context elem isVisible props refs state contextType defaultProps Accessors # hoverTarget targetElem Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getPosition getSnapshotBeforeUpdate onEnterTarget onLeaveTarget refreshPosition render setPosition setState shouldComponentUpdate Constructors # constructor # \u2022 new Tooltip ( props ) Parameters # Name Type props TooltipProps Overrides # React.Component.constructor Properties # activePosition # \u2022 activePosition : TooltipPosition context # \u2022 context : any 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 Inherited from # React.Component.context elem # \u2022 elem : HTMLElement isVisible # \u2022 isVisible : boolean = !!this.props.visible props # \u2022 Readonly props : Readonly < TooltipProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # hoverTarget # \u2022 get hoverTarget (): HTMLElement Returns # HTMLElement targetElem # \u2022 get targetElem (): HTMLElement Returns # HTMLElement Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TooltipProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < TooltipProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < TooltipProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getPosition # \u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object Parameters # Name Type position TooltipPosition tooltipBounds DOMRect targetBounds DOMRect Returns # Object Name Type bottom number left number right number top number getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < TooltipProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onEnterTarget # \u25b8 Protected onEnterTarget (): void Returns # void onLeaveTarget # \u25b8 Protected onLeaveTarget (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setPosition # \u25b8 Protected setPosition ( pos ): void Parameters # Name Type pos Object pos.left number pos.top number Returns # void setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TooltipProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Tooltip"},{"location":"extensions/api/classes/renderer.component.tooltip/#class-tooltip","text":"Renderer . Component .Tooltip","title":"Class: Tooltip"},{"location":"extensions/api/classes/renderer.component.tooltip/#hierarchy","text":"Component < TooltipProps > \u21b3 Tooltip","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.tooltip/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.tooltip/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tooltip/#properties","text":"activePosition context elem isVisible props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tooltip/#accessors","text":"hoverTarget targetElem","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tooltip/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getPosition getSnapshotBeforeUpdate onEnterTarget onLeaveTarget refreshPosition render setPosition setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tooltip/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.tooltip/#constructor","text":"\u2022 new Tooltip ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.tooltip/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.tooltip/#activeposition","text":"\u2022 activePosition : TooltipPosition","title":"activePosition"},{"location":"extensions/api/classes/renderer.component.tooltip/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.tooltip/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.tooltip/#isvisible","text":"\u2022 isVisible : boolean = !!this.props.visible","title":"isVisible"},{"location":"extensions/api/classes/renderer.component.tooltip/#props","text":"\u2022 Readonly props : Readonly < TooltipProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.tooltip/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.tooltip/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.tooltip/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.tooltip/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.tooltip/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.tooltip/#hovertarget","text":"\u2022 get hoverTarget (): HTMLElement","title":"hoverTarget"},{"location":"extensions/api/classes/renderer.component.tooltip/#targetelem","text":"\u2022 get targetElem (): HTMLElement","title":"targetElem"},{"location":"extensions/api/classes/renderer.component.tooltip/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.tooltip/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.tooltip/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tooltip/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tooltip/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.tooltip/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.tooltip/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.tooltip/#getposition","text":"\u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object","title":"getPosition"},{"location":"extensions/api/classes/renderer.component.tooltip/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.tooltip/#onentertarget","text":"\u25b8 Protected onEnterTarget (): void","title":"onEnterTarget"},{"location":"extensions/api/classes/renderer.component.tooltip/#onleavetarget","text":"\u25b8 Protected onLeaveTarget (): void","title":"onLeaveTarget"},{"location":"extensions/api/classes/renderer.component.tooltip/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/renderer.component.tooltip/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.tooltip/#setposition","text":"\u25b8 Protected setPosition ( pos ): void","title":"setPosition"},{"location":"extensions/api/classes/renderer.component.tooltip/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.tooltip/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/","text":"Class: Wizard # Renderer . Component .Wizard Hierarchy # Component < WizardProps , State> \u21b3 Wizard Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # step steps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate firstStep forceUpdate getSnapshotBeforeUpdate getValidStep isFirstStep isLastStep lastStep nextStep prevStep render setState shouldComponentUpdate Constructors # constructor # \u2022 new Wizard ( props ) Parameters # Name Type props WizardProps | Readonly < WizardProps > Inherited from # React.Component.constructor \u2022 new Wizard ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Accessors # step # \u2022 get step (): number Returns # number \u2022 set step ( step ): void Parameters # Name Type step number Returns # void steps # \u2022 get steps (): ReactElement < WizardStepProps , string | JSXElementConstructor>[] Returns # ReactElement < WizardStepProps , string | JSXElementConstructor>[] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < WizardProps > prevState Readonly snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.componentWillUpdate firstStep # \u25b8 firstStep (): any Returns # any forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < WizardProps > prevState Readonly Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getValidStep # \u25b8 Protected getValidStep ( step ): number Parameters # Name Type step number Returns # number isFirstStep # \u25b8 isFirstStep (): boolean Returns # boolean isLastStep # \u25b8 isLastStep (): boolean Returns # boolean lastStep # \u25b8 lastStep (): any Returns # any nextStep # \u25b8 nextStep (): any Returns # any prevStep # \u25b8 prevStep (): any Returns # any render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : \"step\" Parameters # Name Type state State | ( prevState : Readonly , props : Readonly < WizardProps >) => State | Pick | Pick callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < WizardProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Wizard"},{"location":"extensions/api/classes/renderer.component.wizard/#class-wizard","text":"Renderer . Component .Wizard","title":"Class: Wizard"},{"location":"extensions/api/classes/renderer.component.wizard/#hierarchy","text":"Component < WizardProps , State> \u21b3 Wizard","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.wizard/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.wizard/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizard/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizard/#accessors","text":"step steps","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.wizard/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate firstStep forceUpdate getSnapshotBeforeUpdate getValidStep isFirstStep isLastStep lastStep nextStep prevStep render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizard/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizard/#constructor","text":"\u2022 new Wizard ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.wizard/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizard/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.wizard/#props","text":"\u2022 Readonly props : Readonly < WizardProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.wizard/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.wizard/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/renderer.component.wizard/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.wizard/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.wizard/#step","text":"\u2022 get step (): number","title":"step"},{"location":"extensions/api/classes/renderer.component.wizard/#steps","text":"\u2022 get steps (): ReactElement < WizardStepProps , string | JSXElementConstructor>[]","title":"steps"},{"location":"extensions/api/classes/renderer.component.wizard/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizard/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizard/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizard/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.wizard/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.wizard/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizard/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizard/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.wizard/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/#firststep","text":"\u25b8 firstStep (): any","title":"firstStep"},{"location":"extensions/api/classes/renderer.component.wizard/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.wizard/#getvalidstep","text":"\u25b8 Protected getValidStep ( step ): number","title":"getValidStep"},{"location":"extensions/api/classes/renderer.component.wizard/#isfirststep","text":"\u25b8 isFirstStep (): boolean","title":"isFirstStep"},{"location":"extensions/api/classes/renderer.component.wizard/#islaststep","text":"\u25b8 isLastStep (): boolean","title":"isLastStep"},{"location":"extensions/api/classes/renderer.component.wizard/#laststep","text":"\u25b8 lastStep (): any","title":"lastStep"},{"location":"extensions/api/classes/renderer.component.wizard/#nextstep","text":"\u25b8 nextStep (): any","title":"nextStep"},{"location":"extensions/api/classes/renderer.component.wizard/#prevstep","text":"\u25b8 prevStep (): any","title":"prevStep"},{"location":"extensions/api/classes/renderer.component.wizard/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.wizard/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.wizard/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/","text":"Class: WizardLayout # Renderer . Component .WizardLayout Hierarchy # Component < WizardLayoutProps > \u21b3 WizardLayout Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new WizardLayout ( props ) Parameters # Name Type props WizardLayoutProps | Readonly < WizardLayoutProps > Inherited from # React.Component.constructor \u2022 new WizardLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardLayoutProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardLayoutProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardLayoutProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < WizardLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardLayoutProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void 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 Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < WizardLayoutProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < WizardLayoutProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: WizardLayout"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#class-wizardlayout","text":"Renderer . Component .WizardLayout","title":"Class: WizardLayout"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#hierarchy","text":"Component < WizardLayoutProps > \u21b3 WizardLayout","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#constructor","text":"\u2022 new WizardLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#props","text":"\u2022 Readonly props : Readonly < WizardLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void 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 .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.wizardlayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/","text":"Class: WizardStep # Renderer . Component .WizardStep Hierarchy # Component < WizardStepProps , WizardStepState> \u21b3 WizardStep Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate next prev render renderLoading setState shouldComponentUpdate submit Constructors # constructor # \u2022 new WizardStep ( props ) Parameters # Name Type props WizardStepProps | Readonly < WizardStepProps > Inherited from # React.Component.constructor \u2022 new WizardStep ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardStepProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any 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 Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardStepProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : WizardStepState = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context 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 Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : WizardStepProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void 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 Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardStepProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardStepProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void 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 # Name Type prevProps Readonly < WizardStepProps > prevState Readonly snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void 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 Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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 # Name Type nextProps Readonly < WizardStepProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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 # Name Type nextProps Readonly < WizardStepProps > nextState Readonly nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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 # Name Type prevProps Readonly < WizardStepProps > prevState Readonly Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate next # \u25b8 next (): void Returns # void prev # \u25b8 prev (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderLoading # \u25b8 renderLoading (): Element Returns # Element setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : \"waiting\" Parameters # Name Type state WizardStepState | ( prevState : Readonly , props : Readonly < WizardStepProps \\>) => WizardStepState | Pick | Pick callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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 # Name Type nextProps Readonly < WizardStepProps > nextState Readonly nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate submit # \u25b8 submit (): void Returns # void","title":"Class: WizardStep"},{"location":"extensions/api/classes/renderer.component.wizardstep/#class-wizardstep","text":"Renderer . Component .WizardStep","title":"Class: WizardStep"},{"location":"extensions/api/classes/renderer.component.wizardstep/#hierarchy","text":"Component < WizardStepProps , WizardStepState> \u21b3 WizardStep","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.wizardstep/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.wizardstep/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizardstep/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizardstep/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate next prev render renderLoading setState shouldComponentUpdate submit","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizardstep/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.wizardstep/#constructor","text":"\u2022 new WizardStep ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.wizardstep/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.wizardstep/#context","text":"\u2022 context : any 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","title":"context"},{"location":"extensions/api/classes/renderer.component.wizardstep/#props","text":"\u2022 Readonly props : Readonly < WizardStepProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.wizardstep/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.wizardstep/#state","text":"\u2022 state : WizardStepState = {}","title":"state"},{"location":"extensions/api/classes/renderer.component.wizardstep/#contexttype","text":"\u25aa Static Optional contextType : Context 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","title":"contextType"},{"location":"extensions/api/classes/renderer.component.wizardstep/#defaultprops","text":"\u25aa Static defaultProps : WizardStepProps ","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.wizardstep/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.wizardstep/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void 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","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizardstep/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizardstep/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void 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","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may 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","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.wizardstep/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void 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","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any 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.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#next","text":"\u25b8 next (): void","title":"next"},{"location":"extensions/api/classes/renderer.component.wizardstep/#prev","text":"\u25b8 prev (): void","title":"prev"},{"location":"extensions/api/classes/renderer.component.wizardstep/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.wizardstep/#renderloading","text":"\u25b8 renderLoading (): Element","title":"renderLoading"},{"location":"extensions/api/classes/renderer.component.wizardstep/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.wizardstep/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean 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.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.wizardstep/#submit","text":"\u25b8 submit (): void","title":"submit"},{"location":"extensions/api/classes/renderer.ipc/","text":"Class: Ipc # Renderer .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast invoke listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@43866 extension # \u2022 Protected extension : LensExtension Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ... args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast invoke # \u25b8 invoke ( channel , ... args ): Promise Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID. Parameters # Name Type Description channel string The channel to invoke a RPC on ...args any [] The arguments to pass to the RPC Returns # Promise A promise of the resulting value listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice. Parameters # Name Type Description channel string The channel to listen for broadcasts on listener ( event : IpcRendererEvent , ... args : any []) => any The function that will be called with the arguments of the broadcast Returns # Disposer An optional disposer, Lens will cleanup even if this is not called createInstance # \u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/renderer.ipc/#class-ipc","text":"Renderer .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/renderer.ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/renderer.ipc/#methods","text":"broadcast invoke listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/renderer.ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/renderer.ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/renderer.ipc/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/renderer.ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.ipc/#broadcast","text":"\u25b8 broadcast ( channel , ... args ): void","title":"broadcast"},{"location":"extensions/api/classes/renderer.ipc/#invoke","text":"\u25b8 invoke ( channel , ... args ): Promise Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID.","title":"invoke"},{"location":"extensions/api/classes/renderer.ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice.","title":"listen"},{"location":"extensions/api/classes/renderer.ipc/#createinstance","text":"\u25b8 Static createInstance (... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/renderer.ipc/#getinstance","text":"\u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/renderer.ipc/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/","text":"Class: ClusterRole # Renderer . K8sApi .ClusterRole Hierarchy # KubeObject \u21b3 ClusterRole Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRole ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata rules # \u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterroles\" kind # \u25aa Static kind : string = \"ClusterRole\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] Returns # { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ClusterRole > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRole"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#class-clusterrole","text":"Renderer . K8sApi .ClusterRole","title":"Class: ClusterRole"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#hierarchy","text":"KubeObject \u21b3 ClusterRole","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#properties","text":"apiVersion kind managedFields metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#constructor","text":"\u2022 new ClusterRole ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#rules","text":"\u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"rules"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterroles\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#kind_1","text":"\u25aa Static kind : string = \"ClusterRole\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getrules","text":"\u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"getRules"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrole/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/","text":"Class: ClusterRoleBinding # Renderer . K8sApi .ClusterRoleBinding Hierarchy # KubeObject \u21b3 ClusterRoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRoleBinding ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : Object Type declaration # Name Type apiGroup? string kind string name string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status subjects # \u2022 Optional subjects : ClusterRoleBindingSubject [] apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterrolebindings\" kind # \u25aa Static kind : string = \"ClusterRoleBinding\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): ClusterRoleBindingSubject [] Returns # ClusterRoleBindingSubject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ClusterRoleBinding > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#class-clusterrolebinding","text":"Renderer . K8sApi .ClusterRoleBinding","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#hierarchy","text":"KubeObject \u21b3 ClusterRoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#properties","text":"apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#constructor","text":"\u2022 new ClusterRoleBinding ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#roleref","text":"\u2022 roleRef : Object","title":"roleRef"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#subjects","text":"\u2022 Optional subjects : ClusterRoleBindingSubject []","title":"subjects"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterrolebindings\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#kind_1","text":"\u25aa Static kind : string = \"ClusterRoleBinding\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#getsubjects","text":"\u25b8 getSubjects (): ClusterRoleBindingSubject []","title":"getSubjects"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.clusterrolebinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/","text":"Class: ConfigMap # Renderer . K8sApi .ConfigMap Hierarchy # KubeObject \u21b3 ConfigMap Table of contents # Constructors # constructor Properties # apiVersion data kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ConfigMap ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion data # \u2022 data : Object Index signature # \u25aa [param: string ]: string kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/configmaps\" kind # \u25aa Static kind : string = \"ConfigMap\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ConfigMap > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ConfigMap"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#class-configmap","text":"Renderer . K8sApi .ConfigMap","title":"Class: ConfigMap"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#hierarchy","text":"KubeObject \u21b3 ConfigMap","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#properties","text":"apiVersion data kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#methods","text":"delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#constructor","text":"\u2022 new ConfigMap ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#data","text":"\u2022 data : Object","title":"data"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/configmaps\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#kind_1","text":"\u25aa Static kind : string = \"ConfigMap\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.configmap/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/","text":"Class: ConfigMapsStore # Renderer . K8sApi .ConfigMapsStore Hierarchy # KubeObjectStore < ConfigMap > \u21b3 ConfigMapsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ConfigMapsStore ( api? ) Parameters # Name Type api? KubeApi < ConfigMap > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < ConfigMap > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < ConfigMap > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < ConfigMap , void, undefined> Returns # Generator < ConfigMap , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ConfigMap [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # ConfigMap [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): ConfigMap Parameters # Name Type id string Returns # ConfigMap Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ConfigMap [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # ConfigMap [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): ConfigMap Parameters # Name Type name string namespace? string Returns # ConfigMap Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): ConfigMap Parameters # Name Type path string Returns # ConfigMap Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items ConfigMap [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ConfigMap Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems ConfigMap [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap > Parameters # Name Type resourcePath string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ConfigMap []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < ConfigMap > Returns # Promise < ConfigMap []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ConfigMap [] Parameters # Name Type partialItems ConfigMap [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # ConfigMap [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < ConfigMap > Parameters # Name Type item ConfigMap patch Patch Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item ConfigMap Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item ConfigMap request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): ConfigMap [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items ConfigMap [] the items to be sorted (default: the current items in this store) sorting ( item : ConfigMap ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ConfigMap [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems ConfigMap [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < ConfigMap > Parameters # Name Type item ConfigMap data Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ConfigMap > Parameters # Name Type item ConfigMap request () => Promise < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . updateItem","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#class-configmapsstore","text":"Renderer . K8sApi .ConfigMapsStore","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#hierarchy","text":"KubeObjectStore < ConfigMap > \u21b3 ConfigMapsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#constructor","text":"\u2022 new ConfigMapsStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#api","text":"\u2022 api : KubeApi < ConfigMap >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#items","text":"\u2022 items : IObservableArray < ConfigMap >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#iterator","text":"\u25b8 [iterator] (): Generator < ConfigMap , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#create","text":"\u25b8 create ( params , data? ): Promise < ConfigMap >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < ConfigMap >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ConfigMap []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ConfigMap []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getbyid","text":"\u25b8 getById ( id ): ConfigMap","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ConfigMap []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): ConfigMap","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getbypath","text":"\u25b8 getByPath ( path ): ConfigMap","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getitems","text":"\u25b8 getItems (): ConfigMap []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#load","text":"\u25b8 load ( params ): Promise < ConfigMap >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < ConfigMap >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < ConfigMap []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ConfigMap []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ConfigMap >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): ConfigMap [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#update","text":"\u25b8 update ( item , data ): Promise < ConfigMap >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.configmapsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ConfigMap >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/","text":"Class: CRDResourceStore # Renderer . K8sApi .CRDResourceStore Type parameters # Name Type K K : KubeObject Hierarchy # KubeObjectStore \u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDResourceStore ( api ) Type parameters # Name Type K K : KubeObject Parameters # Name Type api KubeApi Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator Returns # Generator Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise Parameters # Name Type params Object params.name string params.namespace? string data? Partial Returns # Promise Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise Parameters # Name Type params Object params.name string params.namespace? string data? Partial Returns # Promise Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # K [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): K Parameters # Name Type id string Returns # K Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # K [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): K Parameters # Name Type name string namespace? string Returns # K Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): K Parameters # Name Type path string Returns # K Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items K [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems K [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise Parameters # Name Type resourcePath string Returns # Promise Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): K [] Parameters # Name Type partialItems K [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # K [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise Parameters # Name Type item K patch Patch Returns # Promise Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item K Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item K request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): K [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items K [] the items to be sorted (default: the current items in this store) sorting ( item : K ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # K [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems K [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise Parameters # Name Type item K data Partial Returns # Promise Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise Parameters # Name Type item K request () => Promise Returns # Promise Inherited from # KubeObjectStore . updateItem","title":"Class: CRDResourceStore"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#class-crdresourcestorek","text":"Renderer . K8sApi .CRDResourceStore","title":"Class: CRDResourceStore<K>"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#type-parameters","text":"Name Type K K : KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#hierarchy","text":"KubeObjectStore \u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#constructor","text":"\u2022 new CRDResourceStore ( api )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#api","text":"\u2022 api : KubeApi ","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#items","text":"\u2022 items : IObservableArray ","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#iterator","text":"\u25b8 [iterator] (): Generator ","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#create","text":"\u25b8 create ( params , data? ): Promise ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise ","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getbyid","text":"\u25b8 getById ( id ): K","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): K","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getbypath","text":"\u25b8 getByPath ( path ): K","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#load","text":"\u25b8 load ( params ): Promise ","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise ","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise ","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise ","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): K []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#patch","text":"\u25b8 patch ( item , patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): K [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#update","text":"\u25b8 update ( item , data ): Promise ","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.crdresourcestore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise ","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/","text":"Class: CRDStore # Renderer . K8sApi .CRDStore Hierarchy # KubeObjectStore < CustomResourceDefinition > \u21b3 CRDStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady groups namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < CustomResourceDefinition > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < CustomResourceDefinition > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } groups # \u2022 get groups (): Record Returns # Record namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < CustomResourceDefinition , void, undefined> Returns # Generator < CustomResourceDefinition , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getAllByNs getByGroup # \u25b8 getByGroup ( group , pluralName ): CustomResourceDefinition Parameters # Name Type group string pluralName string Returns # CustomResourceDefinition getById # \u25b8 getById ( id ): CustomResourceDefinition Parameters # Name Type id string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CustomResourceDefinition [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): CustomResourceDefinition Parameters # Name Type name string namespace? string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getByName getByObject # \u25b8 getByObject ( obj ): CustomResourceDefinition Parameters # Name Type obj KubeObject Returns # CustomResourceDefinition getByPath # \u25b8 getByPath ( path ): CustomResourceDefinition Parameters # Name Type path string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items CustomResourceDefinition [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CustomResourceDefinition Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems CustomResourceDefinition [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition > Parameters # Name Type resourcePath string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CustomResourceDefinition []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CustomResourceDefinition [] Parameters # Name Type partialItems CustomResourceDefinition [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition patch Patch Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item CustomResourceDefinition Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item CustomResourceDefinition request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems CustomResourceDefinition [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition data Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition request () => Promise < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . updateItem","title":"Class: CRDStore"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#class-crdstore","text":"Renderer . K8sApi .CRDStore","title":"Class: CRDStore"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#hierarchy","text":"KubeObjectStore < CustomResourceDefinition > \u21b3 CRDStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#accessors","text":"context contextItems contextReady groups namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#constructor","text":"\u2022 new CRDStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#api","text":"\u2022 api : KubeApi < CustomResourceDefinition >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#items","text":"\u2022 items : IObservableArray < CustomResourceDefinition >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#groups","text":"\u2022 get groups (): Record ","title":"groups"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#iterator","text":"\u25b8 [iterator] (): Generator < CustomResourceDefinition , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#create","text":"\u25b8 create ( params , data? ): Promise < CustomResourceDefinition >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < CustomResourceDefinition >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbygroup","text":"\u25b8 getByGroup ( group , pluralName ): CustomResourceDefinition","title":"getByGroup"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbyid","text":"\u25b8 getById ( id ): CustomResourceDefinition","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CustomResourceDefinition []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): CustomResourceDefinition","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbyobject","text":"\u25b8 getByObject ( obj ): CustomResourceDefinition","title":"getByObject"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getbypath","text":"\u25b8 getByPath ( path ): CustomResourceDefinition","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getitems","text":"\u25b8 getItems (): CustomResourceDefinition []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#load","text":"\u25b8 load ( params ): Promise < CustomResourceDefinition >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < CustomResourceDefinition >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < CustomResourceDefinition []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CustomResourceDefinition []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CustomResourceDefinition >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#sortitems","text":"\u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#update","text":"\u25b8 update ( item , data ): Promise < CustomResourceDefinition >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.crdstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/","text":"Class: CronJob # Renderer . K8sApi .CronJob Hierarchy # KubeObject \u21b3 CronJob Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CronJob ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type concurrencyPolicy string failedJobsHistoryLimit number jobTemplate Object jobTemplate.metadata Object jobTemplate.metadata.annotations? Object jobTemplate.metadata.creationTimestamp? string jobTemplate.metadata.labels? Object jobTemplate.spec Object jobTemplate.spec.template Object jobTemplate.spec.template.metadata Object jobTemplate.spec.template.metadata.creationTimestamp? string jobTemplate.spec.template.spec Object jobTemplate.spec.template.spec.containers IPodContainer [] jobTemplate.spec.template.spec.dnsPolicy string jobTemplate.spec.template.spec.hostPID boolean jobTemplate.spec.template.spec.restartPolicy string jobTemplate.spec.template.spec.schedulerName string jobTemplate.spec.template.spec.terminationGracePeriodSeconds number schedule string successfulJobsHistoryLimit number suspend boolean Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type lastScheduleTime? string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/batch/v1beta1/cronjobs\" kind # \u25aa Static kind : string = \"CronJob\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastScheduleTime # \u25b8 getLastScheduleTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSchedule # \u25b8 getSchedule (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSuspendFlag # \u25b8 getSuspendFlag (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow isNeverRun # \u25b8 isNeverRun (): boolean Returns # boolean isSuspend # \u25b8 isSuspend (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < CronJob > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CronJob"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#class-cronjob","text":"Renderer . K8sApi .CronJob","title":"Class: CronJob"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#hierarchy","text":"KubeObject \u21b3 CronJob","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#constructor","text":"\u2022 new CronJob ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#apibase","text":"\u25aa Static apiBase : string = \"/apis/batch/v1beta1/cronjobs\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#kind_1","text":"\u25aa Static kind : string = \"CronJob\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getlastscheduletime","text":"\u25b8 getLastScheduleTime (): string","title":"getLastScheduleTime"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getschedule","text":"\u25b8 getSchedule (): string","title":"getSchedule"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#getsuspendflag","text":"\u25b8 getSuspendFlag (): string","title":"getSuspendFlag"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#isneverrun","text":"\u25b8 isNeverRun (): boolean","title":"isNeverRun"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#issuspend","text":"\u25b8 isSuspend (): boolean","title":"isSuspend"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.cronjob/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/","text":"Class: CronJobStore # Renderer . K8sApi .CronJobStore Hierarchy # KubeObjectStore < CronJob > \u21b3 CronJobStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CronJobStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : CronJobApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < CronJob > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < CronJob , void, undefined> Returns # Generator < CronJob , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore . filterItemsOnLoad getActiveJobsNum # \u25b8 getActiveJobsNum ( cronJob ): number Parameters # Name Type cronJob CronJob Returns # number getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CronJob [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # CronJob [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): CronJob Parameters # Name Type id string Returns # CronJob Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CronJob [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # CronJob [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): CronJob Parameters # Name Type name string namespace? string Returns # CronJob Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): CronJob Parameters # Name Type path string Returns # CronJob Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( cronJobs? ): Object Parameters # Name Type cronJobs? CronJob [] Returns # Object Name Type scheduled number suspended number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CronJob Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems CronJob [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CronJob > Parameters # Name Type resourcePath string Returns # Promise < CronJob > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CronJob []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < CronJob > Returns # Promise < CronJob []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CronJob [] Parameters # Name Type partialItems CronJob [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # CronJob [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < CronJob > Parameters # Name Type item CronJob patch Patch Returns # Promise < CronJob > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item CronJob Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item CronJob request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): CronJob [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items CronJob [] the items to be sorted (default: the current items in this store) sorting ( item : CronJob ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # CronJob [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems CronJob [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < CronJob > Parameters # Name Type item CronJob data Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CronJob > Parameters # Name Type item CronJob request () => Promise < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . updateItem","title":"Class: CronJobStore"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#class-cronjobstore","text":"Renderer . K8sApi .CronJobStore","title":"Class: CronJobStore"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#hierarchy","text":"KubeObjectStore < CronJob > \u21b3 CronJobStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#constructor","text":"\u2022 new CronJobStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#api","text":"\u2022 api : CronJobApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#items","text":"\u2022 items : IObservableArray < CronJob >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#iterator","text":"\u25b8 [iterator] (): Generator < CronJob , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#create","text":"\u25b8 create ( params , data? ): Promise < CronJob >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < CronJob >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CronJob []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getactivejobsnum","text":"\u25b8 getActiveJobsNum ( cronJob ): number","title":"getActiveJobsNum"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CronJob []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getbyid","text":"\u25b8 getById ( id ): CronJob","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CronJob []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): CronJob","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getbypath","text":"\u25b8 getByPath ( path ): CronJob","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getitems","text":"\u25b8 getItems (): CronJob []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#getstatuses","text":"\u25b8 getStatuses ( cronJobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#load","text":"\u25b8 load ( params ): Promise < CronJob >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CronJob >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < CronJob >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < CronJob []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CronJob []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CronJob >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): CronJob [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#update","text":"\u25b8 update ( item , data ): Promise < CronJob >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.cronjobstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CronJob >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/","text":"Class: CustomResourceDefinition # Renderer . K8sApi .CustomResourceDefinition Hierarchy # KubeObject \u21b3 CustomResourceDefinition Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getConversion getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CustomResourceDefinition ( data ) Parameters # Name Type data CRDApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type additionalPrinterColumns? AdditionalPrinterColumnsV1Beta [] conversion Object conversion.strategy? string conversion.webhook? any group string names Object names.kind string names.listKind string names.plural string names.singular string scope string validation? object version? string versions? CRDVersion [] Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type acceptedNames Object acceptedNames.kind string acceptedNames.listKind string acceptedNames.plural string acceptedNames.shortNames string [] acceptedNames.singular string conditions { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string }[] storedVersions string [] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/apiextensions.k8s.io/v1/customresourcedefinitions\" kind # \u25aa Static kind : string = \"CustomResourceDefinition\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[] Returns # { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[] getConversion # \u25b8 getConversion (): string Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGroup # \u25b8 getGroup (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNames # \u25b8 getNames (): Object Returns # Object Name Type kind string listKind string plural string singular string getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPluralName # \u25b8 getPluralName (): string Returns # string getPreferedVersion # \u25b8 getPreferedVersion (): CRDVersion Returns # CRDVersion getPrinterColumns # \u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 [] Parameters # Name Type Default value ignorePriority boolean true Returns # AdditionalPrinterColumnsV1 [] getResourceApiBase # \u25b8 getResourceApiBase (): string Returns # string getResourceKind # \u25b8 getResourceKind (): string Returns # string getResourceTitle # \u25b8 getResourceTitle (): string Returns # string getResourceUrl # \u25b8 getResourceUrl (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScope # \u25b8 getScope (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStoredVersions # \u25b8 getStoredVersions (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValidation # \u25b8 getValidation (): string Returns # string getVersion # \u25b8 getVersion (): string Returns # string isNamespaced # \u25b8 isNamespaced (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < CustomResourceDefinition > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#class-customresourcedefinition","text":"Renderer . K8sApi .CustomResourceDefinition","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#hierarchy","text":"KubeObject \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#methods","text":"delete getAge getAnnotations getConditions getConversion getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#constructor","text":"\u2022 new CustomResourceDefinition ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apiextensions.k8s.io/v1/customresourcedefinitions\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#kind_1","text":"\u25aa Static kind : string = \"CustomResourceDefinition\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[]","title":"getConditions"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getconversion","text":"\u25b8 getConversion (): string","title":"getConversion"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getgroup","text":"\u25b8 getGroup (): string","title":"getGroup"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getnames","text":"\u25b8 getNames (): Object","title":"getNames"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getpluralname","text":"\u25b8 getPluralName (): string","title":"getPluralName"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getpreferedversion","text":"\u25b8 getPreferedVersion (): CRDVersion","title":"getPreferedVersion"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getprintercolumns","text":"\u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 []","title":"getPrinterColumns"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getresourceapibase","text":"\u25b8 getResourceApiBase (): string","title":"getResourceApiBase"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getresourcekind","text":"\u25b8 getResourceKind (): string","title":"getResourceKind"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getresourcetitle","text":"\u25b8 getResourceTitle (): string","title":"getResourceTitle"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getresourceurl","text":"\u25b8 getResourceUrl (): string","title":"getResourceUrl"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getscope","text":"\u25b8 getScope (): string","title":"getScope"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getstoredversions","text":"\u25b8 getStoredVersions (): string","title":"getStoredVersions"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getvalidation","text":"\u25b8 getValidation (): string","title":"getValidation"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#getversion","text":"\u25b8 getVersion (): string","title":"getVersion"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#isnamespaced","text":"\u25b8 isNamespaced (): boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.customresourcedefinition/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/","text":"Class: DaemonSet # Renderer . K8sApi .DaemonSet Hierarchy # WorkloadKubeObject \u21b3 DaemonSet Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new DaemonSet ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type revisionHistoryLimit number selector Object selector.matchLabels Object template Object template.metadata Object template.metadata.creationTimestamp? string template.metadata.labels Object template.metadata.labels.name string template.spec Object template.spec.affinity? IAffinity template.spec.containers IPodContainer [] template.spec.dnsPolicy string template.spec.hostPID boolean template.spec.initContainers? IPodContainer [] template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.securityContext Object template.spec.terminationGracePeriodSeconds number template.spec.tolerations { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] updateStrategy Object updateStrategy.rollingUpdate Object updateStrategy.rollingUpdate.maxUnavailable number updateStrategy.type string Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type currentNumberScheduled number desiredNumberScheduled number numberAvailable number numberMisscheduled number numberReady number numberUnavailable number observedGeneration number updatedNumberScheduled number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/daemonsets\" kind # \u25aa Static kind : string = \"DaemonSet\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < DaemonSet > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: DaemonSet"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#class-daemonset","text":"Renderer . K8sApi .DaemonSet","title":"Class: DaemonSet"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#hierarchy","text":"WorkloadKubeObject \u21b3 DaemonSet","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#constructor","text":"\u2022 new DaemonSet ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/daemonsets\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#kind_1","text":"\u25aa Static kind : string = \"DaemonSet\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.daemonset/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/","text":"Class: DaemonSetStore # Renderer . K8sApi .DaemonSetStore Hierarchy # KubeObjectStore < DaemonSet > \u21b3 DaemonSetStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DaemonSetStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : DaemonSetApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < DaemonSet > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < DaemonSet , void, undefined> Returns # Generator < DaemonSet , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): DaemonSet [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # DaemonSet [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): DaemonSet Parameters # Name Type id string Returns # DaemonSet Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): DaemonSet [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # DaemonSet [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): DaemonSet Parameters # Name Type name string namespace? string Returns # DaemonSet Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): DaemonSet Parameters # Name Type path string Returns # DaemonSet Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( daemonSet ): Pod [] Parameters # Name Type daemonSet DaemonSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( daemonSets? ): Object Parameters # Name Type daemonSets? DaemonSet [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item DaemonSet Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems DaemonSet [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet > Parameters # Name Type resourcePath string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < DaemonSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < DaemonSet > Returns # Promise < DaemonSet []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): DaemonSet [] Parameters # Name Type partialItems DaemonSet [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # DaemonSet [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < DaemonSet > Parameters # Name Type item DaemonSet patch Patch Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item DaemonSet Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item DaemonSet request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): DaemonSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items DaemonSet [] the items to be sorted (default: the current items in this store) sorting ( item : DaemonSet ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # DaemonSet [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems DaemonSet [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < DaemonSet > Parameters # Name Type item DaemonSet data Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < DaemonSet > Parameters # Name Type item DaemonSet request () => Promise < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . updateItem","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#class-daemonsetstore","text":"Renderer . K8sApi .DaemonSetStore","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#hierarchy","text":"KubeObjectStore < DaemonSet > \u21b3 DaemonSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#constructor","text":"\u2022 new DaemonSetStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#api","text":"\u2022 api : DaemonSetApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#items","text":"\u2022 items : IObservableArray < DaemonSet >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#iterator","text":"\u25b8 [iterator] (): Generator < DaemonSet , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#create","text":"\u25b8 create ( params , data? ): Promise < DaemonSet >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < DaemonSet >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): DaemonSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): DaemonSet []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getbyid","text":"\u25b8 getById ( id ): DaemonSet","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): DaemonSet []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): DaemonSet","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getbypath","text":"\u25b8 getByPath ( path ): DaemonSet","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getchildpods","text":"\u25b8 getChildPods ( daemonSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getitems","text":"\u25b8 getItems (): DaemonSet []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#getstatuses","text":"\u25b8 getStatuses ( daemonSets? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#load","text":"\u25b8 load ( params ): Promise < DaemonSet >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < DaemonSet >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < DaemonSet []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): DaemonSet []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < DaemonSet >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): DaemonSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#update","text":"\u25b8 update ( item , data ): Promise < DaemonSet >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.daemonsetstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < DaemonSet >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/","text":"Class: Deployment # Renderer . K8sApi .Deployment Hierarchy # WorkloadKubeObject \u21b3 Deployment Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Deployment ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type replicas number selector Object selector.matchLabels Object strategy Object strategy.rollingUpdate Object strategy.rollingUpdate.maxSurge number strategy.rollingUpdate.maxUnavailable number strategy.type string template Object template.metadata Object template.metadata.annotations? Object template.metadata.creationTimestamp? string template.metadata.labels Object template.spec Object template.spec.affinity? IAffinity template.spec.containers { args? : string [] ; env? : { name : string ; value : string }[] ; image : string ; imagePullPolicy : string ; livenessProbe? : IContainerProbe ; name : string ; ports? : { containerPort : number ; name : string ; protocol : string }[] ; readinessProbe? : IContainerProbe ; resources : { limits? : { cpu : string ; memory : string } ; requests : { cpu : string ; memory : string } } ; startupProbe? : IContainerProbe ; terminationMessagePath : string ; terminationMessagePolicy : string ; volumeMounts? : { mountPath : string ; name : string }[] }[] template.spec.dnsPolicy string template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.securityContext Object template.spec.serviceAccount string template.spec.serviceAccountName string template.spec.terminationGracePeriodSeconds number template.spec.tolerations? { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] template.spec.volumes? { configMap : { defaultMode : number ; name : string ; optional : boolean } ; name : string }[] Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type availableReplicas? number conditions { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] observedGeneration number readyReplicas number replicas number unavailableReplicas? number updatedReplicas number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/deployments\" kind # \u25aa Static kind : string = \"Deployment\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getConditions # \u25b8 getConditions ( activeOnly? ): { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] Parameters # Name Type Default value activeOnly boolean false Returns # { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] getConditionsText # \u25b8 getConditionsText ( activeOnly? ): string Parameters # Name Type Default value activeOnly boolean true Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Deployment > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: Deployment"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#class-deployment","text":"Renderer . K8sApi .Deployment","title":"Class: Deployment"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#hierarchy","text":"WorkloadKubeObject \u21b3 Deployment","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#constructor","text":"\u2022 new Deployment ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/deployments\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#kind_1","text":"\u25aa Static kind : string = \"Deployment\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getconditions","text":"\u25b8 getConditions ( activeOnly? ): { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getconditionstext","text":"\u25b8 getConditionsText ( activeOnly? ): string","title":"getConditionsText"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.deployment/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/","text":"Class: DeploymentApi # Renderer . K8sApi .DeploymentApi Hierarchy # KubeApi < Deployment > \u21b3 DeploymentApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getReplicas getResourceVersion getScaleApiUrl getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion restart scale setResourceVersion update watch Constructors # constructor # \u2022 new DeploymentApi ( options ) Parameters # Name Type options IKubeApiOptions < Deployment > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Deployment > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Deployment > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise < Deployment > Inherited from # KubeApi . get getReplicas # \u25b8 getReplicas ( params ): Promise Parameters # Name Type params Object params.name string params.namespace string Returns # Promise getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getScaleApiUrl # \u25b8 Protected getScaleApiUrl ( params ): string Parameters # Name Type params Object params.name string params.namespace string Returns # string getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Deployment []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Deployment []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Deployment | Deployment [] Parameters # Name Type data unknown namespace? string Returns # Deployment | Deployment [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Deployment []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Deployment []> Inherited from # KubeApi . refreshResourceVersion restart # \u25b8 restart ( params ): Promise Parameters # Name Type params Object params.name string params.namespace string Returns # Promise scale # \u25b8 scale ( params , replicas ): Promise Parameters # Name Type params Object params.name string params.namespace string replicas number Returns # Promise setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: DeploymentApi"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#class-deploymentapi","text":"Renderer . K8sApi .DeploymentApi","title":"Class: DeploymentApi"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#hierarchy","text":"KubeApi < Deployment > \u21b3 DeploymentApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#methods","text":"checkPreferredVersion create delete get getReplicas getResourceVersion getScaleApiUrl getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion restart scale setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#constructor","text":"\u2022 new DeploymentApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Deployment >","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#options","text":"\u2022 Protected options : IKubeApiOptions < Deployment >","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Deployment >","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#getreplicas","text":"\u25b8 getReplicas ( params ): Promise ","title":"getReplicas"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#getscaleapiurl","text":"\u25b8 Protected getScaleApiUrl ( params ): string","title":"getScaleApiUrl"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Deployment []>","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Deployment | Deployment []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Deployment []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#restart","text":"\u25b8 restart ( params ): Promise ","title":"restart"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#scale","text":"\u25b8 scale ( params , replicas ): Promise ","title":"scale"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/","text":"Class: DeploymentStore # Renderer . K8sApi .DeploymentStore Hierarchy # KubeObjectStore < Deployment > \u21b3 DeploymentStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DeploymentStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : DeploymentApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Deployment > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Deployment , void, undefined> Returns # Generator < Deployment , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Deployment [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Deployment [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Deployment Parameters # Name Type id string Returns # Deployment Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Deployment [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Deployment [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Deployment Parameters # Name Type name string namespace? string Returns # Deployment Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Deployment Parameters # Name Type path string Returns # Deployment Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( deployment ): Pod [] Parameters # Name Type deployment Deployment Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( deployments? ): Object Parameters # Name Type deployments? Deployment [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Deployment Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Deployment [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Deployment > Parameters # Name Type resourcePath string Returns # Promise < Deployment > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Deployment []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Deployment > Returns # Promise < Deployment []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Deployment [] Parameters # Name Type partialItems Deployment [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Deployment [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Deployment > Parameters # Name Type item Deployment patch Patch Returns # Promise < Deployment > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Deployment Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Deployment request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): Deployment [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items Deployment [] Returns # Deployment [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Deployment [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Deployment > Parameters # Name Type item Deployment data Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Deployment > Parameters # Name Type item Deployment request () => Promise < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . updateItem","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#class-deploymentstore","text":"Renderer . K8sApi .DeploymentStore","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#hierarchy","text":"KubeObjectStore < Deployment > \u21b3 DeploymentStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#constructor","text":"\u2022 new DeploymentStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#api","text":"\u2022 api : DeploymentApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#items","text":"\u2022 items : IObservableArray < Deployment >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#iterator","text":"\u25b8 [iterator] (): Generator < Deployment , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#create","text":"\u25b8 create ( params , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Deployment >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Deployment []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Deployment []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getbyid","text":"\u25b8 getById ( id ): Deployment","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Deployment []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Deployment","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getbypath","text":"\u25b8 getByPath ( path ): Deployment","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getchildpods","text":"\u25b8 getChildPods ( deployment ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getitems","text":"\u25b8 getItems (): Deployment []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#getstatuses","text":"\u25b8 getStatuses ( deployments? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#load","text":"\u25b8 load ( params ): Promise < Deployment >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Deployment >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Deployment >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Deployment []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Deployment []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Deployment >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Deployment [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#update","text":"\u25b8 update ( item , data ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.deploymentstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Deployment >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/","text":"Class: Endpoint # Renderer . K8sApi .Endpoint Hierarchy # KubeObject \u21b3 Endpoint Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status subsets apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Endpoint ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status subsets # \u2022 subsets : IEndpointSubset [] apiBase # \u25aa Static apiBase : string = \"/api/v1/endpoints\" kind # \u25aa Static kind : string = \"Endpoints\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getEndpointSubsets # \u25b8 getEndpointSubsets (): EndpointSubset [] Returns # EndpointSubset [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject toString # \u25b8 toString (): string Returns # string update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Endpoint > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Endpoint"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#class-endpoint","text":"Renderer . K8sApi .Endpoint","title":"Class: Endpoint"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#hierarchy","text":"KubeObject \u21b3 Endpoint","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#properties","text":"apiVersion kind managedFields metadata spec status subsets apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#methods","text":"delete getAge getAnnotations getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#constructor","text":"\u2022 new Endpoint ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#subsets","text":"\u2022 subsets : IEndpointSubset []","title":"subsets"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/endpoints\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#kind_1","text":"\u25aa Static kind : string = \"Endpoints\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getendpointsubsets","text":"\u25b8 getEndpointSubsets (): EndpointSubset []","title":"getEndpointSubsets"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#tostring","text":"\u25b8 toString (): string","title":"toString"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.endpoint/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/","text":"Class: EndpointStore # Renderer . K8sApi .EndpointStore Hierarchy # KubeObjectStore < Endpoint > \u21b3 EndpointStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EndpointStore ( api? ) Parameters # Name Type api? KubeApi < Endpoint > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < Endpoint > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Endpoint > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Endpoint , void, undefined> Returns # Generator < Endpoint , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Endpoint [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Endpoint [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Endpoint Parameters # Name Type id string Returns # Endpoint Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Endpoint [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Endpoint [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Endpoint Parameters # Name Type name string namespace? string Returns # Endpoint Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Endpoint Parameters # Name Type path string Returns # Endpoint Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Endpoint [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Endpoint Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Endpoint [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Endpoint > Parameters # Name Type resourcePath string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Endpoint []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Endpoint > Returns # Promise < Endpoint []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Endpoint [] Parameters # Name Type partialItems Endpoint [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Endpoint [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Endpoint > Parameters # Name Type item Endpoint patch Patch Returns # Promise < Endpoint > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Endpoint Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Endpoint request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Endpoint [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Endpoint [] the items to be sorted (default: the current items in this store) sorting ( item : Endpoint ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Endpoint [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Endpoint [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Endpoint > Parameters # Name Type item Endpoint data Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Endpoint > Parameters # Name Type item Endpoint request () => Promise < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . updateItem","title":"Class: EndpointStore"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#class-endpointstore","text":"Renderer . K8sApi .EndpointStore","title":"Class: EndpointStore"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#hierarchy","text":"KubeObjectStore < Endpoint > \u21b3 EndpointStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#constructor","text":"\u2022 new EndpointStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#api","text":"\u2022 api : KubeApi < Endpoint >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#items","text":"\u2022 items : IObservableArray < Endpoint >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#iterator","text":"\u25b8 [iterator] (): Generator < Endpoint , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#create","text":"\u25b8 create ( params , data? ): Promise < Endpoint >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Endpoint >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Endpoint []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Endpoint []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getbyid","text":"\u25b8 getById ( id ): Endpoint","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Endpoint []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Endpoint","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getbypath","text":"\u25b8 getByPath ( path ): Endpoint","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getitems","text":"\u25b8 getItems (): Endpoint []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#load","text":"\u25b8 load ( params ): Promise < Endpoint >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Endpoint >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Endpoint >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Endpoint []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Endpoint []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Endpoint >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Endpoint [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#update","text":"\u25b8 update ( item , data ): Promise < Endpoint >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.endpointstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Endpoint >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/","text":"Class: EventStore # Renderer . K8sApi .EventStore Hierarchy # KubeObjectStore < KubeEvent > \u21b3 EventStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit saveLimit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getStatuses getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EventStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < KubeEvent > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < KubeEvent > Inherited from # KubeObjectStore . items limit # \u2022 limit : number = 1000 Overrides # KubeObjectStore . limit saveLimit # \u2022 saveLimit : number = 50000 selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < KubeEvent , void, undefined> Returns # Generator < KubeEvent , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater (): void Returns # void Overrides # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): KubeEvent [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # KubeEvent [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): KubeEvent Parameters # Name Type id string Returns # KubeEvent Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): KubeEvent [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # KubeEvent [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): KubeEvent Parameters # Name Type name string namespace? string Returns # KubeEvent Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): KubeEvent Parameters # Name Type path string Returns # KubeEvent Inherited from # KubeObjectStore . getByPath getEventsByObject # \u25b8 getEventsByObject ( obj ): KubeEvent [] Parameters # Name Type obj KubeObject Returns # KubeEvent [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items KubeEvent [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount getWarnings # \u25b8 getWarnings (): KubeEvent [] Returns # KubeEvent [] getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item KubeEvent Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems KubeEvent [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent > Parameters # Name Type resourcePath string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < KubeEvent []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < KubeEvent > Returns # Promise < KubeEvent []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): KubeEvent [] Parameters # Name Type partialItems KubeEvent [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # KubeEvent [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < KubeEvent > Parameters # Name Type item KubeEvent patch Patch Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item KubeEvent Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item KubeEvent request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): KubeEvent [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems KubeEvent [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < KubeEvent > Parameters # Name Type item KubeEvent data Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < KubeEvent > Parameters # Name Type item KubeEvent request () => Promise < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . updateItem","title":"Class: EventStore"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#class-eventstore","text":"Renderer . K8sApi .EventStore","title":"Class: EventStore"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#hierarchy","text":"KubeObjectStore < KubeEvent > \u21b3 EventStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit saveLimit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getStatuses getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#constructor","text":"\u2022 new EventStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#api","text":"\u2022 api : KubeApi < KubeEvent >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#items","text":"\u2022 items : IObservableArray < KubeEvent >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#limit","text":"\u2022 limit : number = 1000","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#savelimit","text":"\u2022 saveLimit : number = 50000","title":"saveLimit"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#iterator","text":"\u25b8 [iterator] (): Generator < KubeEvent , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater (): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#create","text":"\u25b8 create ( params , data? ): Promise < KubeEvent >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < KubeEvent >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): KubeEvent []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): KubeEvent []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getbyid","text":"\u25b8 getById ( id ): KubeEvent","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): KubeEvent []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): KubeEvent","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getbypath","text":"\u25b8 getByPath ( path ): KubeEvent","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#geteventsbyobject","text":"\u25b8 getEventsByObject ( obj ): KubeEvent []","title":"getEventsByObject"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getitems","text":"\u25b8 getItems (): KubeEvent []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getwarnings","text":"\u25b8 getWarnings (): KubeEvent []","title":"getWarnings"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#load","text":"\u25b8 load ( params ): Promise < KubeEvent >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < KubeEvent >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < KubeEvent []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): KubeEvent []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < KubeEvent >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#sortitems","text":"\u25b8 Protected sortItems ( items ): KubeEvent [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#update","text":"\u25b8 update ( item , data ): Promise < KubeEvent >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.eventstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < KubeEvent >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/","text":"Class: HorizontalPodAutoscaler # Renderer . K8sApi .HorizontalPodAutoscaler Hierarchy # KubeObject \u21b3 HorizontalPodAutoscaler Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetricName getMetricValues getMetrics getMinPods getName getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new HorizontalPodAutoscaler ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type maxReplicas number metrics IHpaMetric [] minReplicas number scaleTargetRef Object scaleTargetRef.apiVersion string scaleTargetRef.kind string scaleTargetRef.name string Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type conditions { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type : string }[] currentMetrics IHpaMetric [] currentReplicas number desiredReplicas number Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\" kind # \u25aa Static kind : string = \"HorizontalPodAutoscaler\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[] getCurrentMetrics # \u25b8 getCurrentMetrics (): IHpaMetric [] Returns # IHpaMetric [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxPods # \u25b8 getMaxPods (): number Returns # number getMetricName # \u25b8 Protected getMetricName ( metric ): string Parameters # Name Type metric IHpaMetric Returns # string getMetricValues # \u25b8 getMetricValues ( metric ): string Parameters # Name Type metric IHpaMetric Returns # string getMetrics # \u25b8 getMetrics (): IHpaMetric [] Returns # IHpaMetric [] getMinPods # \u25b8 getMinPods (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < HorizontalPodAutoscaler > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#class-horizontalpodautoscaler","text":"Renderer . K8sApi .HorizontalPodAutoscaler","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#hierarchy","text":"KubeObject \u21b3 HorizontalPodAutoscaler","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#methods","text":"delete getAge getAnnotations getConditions getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetricName getMetricValues getMetrics getMinPods getName getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#constructor","text":"\u2022 new HorizontalPodAutoscaler ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#apibase","text":"\u25aa Static apiBase : string = \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#kind_1","text":"\u25aa Static kind : string = \"HorizontalPodAutoscaler\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getcurrentmetrics","text":"\u25b8 getCurrentMetrics (): IHpaMetric []","title":"getCurrentMetrics"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getmaxpods","text":"\u25b8 getMaxPods (): number","title":"getMaxPods"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getmetricname","text":"\u25b8 Protected getMetricName ( metric ): string","title":"getMetricName"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getmetricvalues","text":"\u25b8 getMetricValues ( metric ): string","title":"getMetricValues"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getmetrics","text":"\u25b8 getMetrics (): IHpaMetric []","title":"getMetrics"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getminpods","text":"\u25b8 getMinPods (): number","title":"getMinPods"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/","text":"Class: HPAStore # Renderer . K8sApi .HPAStore Hierarchy # KubeObjectStore < HorizontalPodAutoscaler > \u21b3 HPAStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new HPAStore ( api? ) Parameters # Name Type api? KubeApi < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < HorizontalPodAutoscaler > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void, undefined> Returns # Generator < HorizontalPodAutoscaler , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): HorizontalPodAutoscaler Parameters # Name Type id string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): HorizontalPodAutoscaler [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): HorizontalPodAutoscaler Parameters # Name Type name string namespace? string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): HorizontalPodAutoscaler Parameters # Name Type path string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items HorizontalPodAutoscaler [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item HorizontalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems HorizontalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < HorizontalPodAutoscaler []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): HorizontalPodAutoscaler [] Parameters # Name Type partialItems HorizontalPodAutoscaler [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler patch Patch Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item HorizontalPodAutoscaler Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item HorizontalPodAutoscaler request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): HorizontalPodAutoscaler [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items HorizontalPodAutoscaler [] the items to be sorted (default: the current items in this store) sorting ( item : HorizontalPodAutoscaler ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems HorizontalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler data Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . updateItem","title":"Class: HPAStore"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#class-hpastore","text":"Renderer . K8sApi .HPAStore","title":"Class: HPAStore"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#hierarchy","text":"KubeObjectStore < HorizontalPodAutoscaler > \u21b3 HPAStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#constructor","text":"\u2022 new HPAStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#api","text":"\u2022 api : KubeApi < HorizontalPodAutoscaler >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#items","text":"\u2022 items : IObservableArray < HorizontalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#iterator","text":"\u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#create","text":"\u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getbyid","text":"\u25b8 getById ( id ): HorizontalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getbylabel","text":"\u25b8 getByLabel ( labels ): HorizontalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): HorizontalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getbypath","text":"\u25b8 getByPath ( path ): HorizontalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getitems","text":"\u25b8 getItems (): HorizontalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#load","text":"\u25b8 load ( params ): Promise < HorizontalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < HorizontalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < HorizontalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): HorizontalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#patch","text":"\u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): HorizontalPodAutoscaler [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#update","text":"\u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.hpastore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/","text":"Class: Ingress # Renderer . K8sApi .Ingress Hierarchy # KubeObject \u21b3 Ingress Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Ingress ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type backend? IExtensionsBackend defaultBackend? INetworkingBackend & { resource : { apiGroup : string ; kind : string ; name : string } } rules? { host? : string ; http : { paths : { backend : IIngressBackend ; path? : string }[] } }[] tls { secretName : string }[] Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type loadBalancer Object loadBalancer.ingress ILoadBalancerIngress [] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/ingresses\" kind # \u25aa Static kind : string = \"Ingress\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getHosts # \u25b8 getHosts (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancers # \u25b8 getLoadBalancers (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoutes # \u25b8 getRoutes (): string [] Returns # string [] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getServiceNamePort # \u25b8 getServiceNamePort (): Object Returns # Object Name Type serviceName string servicePort string | number getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Ingress > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Ingress"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#class-ingress","text":"Renderer . K8sApi .Ingress","title":"Class: Ingress"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#hierarchy","text":"KubeObject \u21b3 Ingress","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#methods","text":"delete getAge getAnnotations getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#constructor","text":"\u2022 new Ingress ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#apibase","text":"\u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/ingresses\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#kind_1","text":"\u25aa Static kind : string = \"Ingress\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#gethosts","text":"\u25b8 getHosts (): string []","title":"getHosts"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getloadbalancers","text":"\u25b8 getLoadBalancers (): string []","title":"getLoadBalancers"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getports","text":"\u25b8 getPorts (): string","title":"getPorts"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getroutes","text":"\u25b8 getRoutes (): string []","title":"getRoutes"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#getservicenameport","text":"\u25b8 getServiceNamePort (): Object","title":"getServiceNamePort"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.ingress/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/","text":"Class: IngressApi # Renderer . K8sApi .IngressApi Hierarchy # KubeApi < Ingress > \u21b3 IngressApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new IngressApi ( options ) Parameters # Name Type options IKubeApiOptions < Ingress > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Ingress > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Ingress > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise < Ingress > Inherited from # KubeApi . get getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Ingress []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Ingress []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Ingress | Ingress [] Parameters # Name Type data unknown namespace? string Returns # Ingress | Ingress [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Ingress []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Ingress []> Inherited from # KubeApi . refreshResourceVersion setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: IngressApi"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#class-ingressapi","text":"Renderer . K8sApi .IngressApi","title":"Class: IngressApi"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#hierarchy","text":"KubeApi < Ingress > \u21b3 IngressApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#constructor","text":"\u2022 new IngressApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Ingress >","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#options","text":"\u2022 Protected options : IKubeApiOptions < Ingress >","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Ingress >","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Ingress []>","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Ingress | Ingress []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Ingress []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.ingressapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/","text":"Class: IngressStore # Renderer . K8sApi .IngressStore Hierarchy # KubeObjectStore < Ingress > \u21b3 IngressStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressStore ( api? ) Parameters # Name Type api? KubeApi < Ingress > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : IngressApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Ingress > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Ingress , void, undefined> Returns # Generator < Ingress , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Ingress [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Ingress [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Ingress Parameters # Name Type id string Returns # Ingress Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Ingress [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Ingress [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Ingress Parameters # Name Type name string namespace? string Returns # Ingress Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Ingress Parameters # Name Type path string Returns # Ingress Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Ingress [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Ingress Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Ingress [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Ingress > Parameters # Name Type resourcePath string Returns # Promise < Ingress > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Ingress []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Ingress > Returns # Promise < Ingress []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Ingress [] Parameters # Name Type partialItems Ingress [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Ingress [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Ingress > Parameters # Name Type item Ingress patch Patch Returns # Promise < Ingress > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Ingress Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Ingress request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Ingress [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Ingress [] the items to be sorted (default: the current items in this store) sorting ( item : Ingress ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Ingress [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Ingress [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Ingress > Parameters # Name Type item Ingress data Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Ingress > Parameters # Name Type item Ingress request () => Promise < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . updateItem","title":"Class: IngressStore"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#class-ingressstore","text":"Renderer . K8sApi .IngressStore","title":"Class: IngressStore"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#hierarchy","text":"KubeObjectStore < Ingress > \u21b3 IngressStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#constructor","text":"\u2022 new IngressStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#api","text":"\u2022 api : IngressApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#items","text":"\u2022 items : IObservableArray < Ingress >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#iterator","text":"\u25b8 [iterator] (): Generator < Ingress , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#create","text":"\u25b8 create ( params , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Ingress >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Ingress []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Ingress []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getbyid","text":"\u25b8 getById ( id ): Ingress","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Ingress []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Ingress","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getbypath","text":"\u25b8 getByPath ( path ): Ingress","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getitems","text":"\u25b8 getItems (): Ingress []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#load","text":"\u25b8 load ( params ): Promise < Ingress >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Ingress >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Ingress >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Ingress []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Ingress []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Ingress >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Ingress [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#update","text":"\u25b8 update ( item , data ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.ingressstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Ingress >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.job/","text":"Class: Job # Renderer . K8sApi .Job Hierarchy # WorkloadKubeObject \u21b3 Job Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Job ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type backoffLimit? number completions? number containers? IPodContainer [] dnsPolicy? string parallelism? number restartPolicy? string schedulerName? string selector? Object selector.matchLabels Object serviceAccount? string serviceAccountName? string template Object template.metadata Object template.metadata.annotations? Object template.metadata.creationTimestamp? string template.metadata.labels? Object template.spec Object template.spec.affinity? IAffinity template.spec.containers IPodContainer [] template.spec.dnsPolicy string template.spec.hostPID boolean template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.terminationGracePeriodSeconds number template.spec.tolerations? { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] terminationGracePeriodSeconds? number Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type completionTime string conditions { lastProbeTime : string ; lastTransitionTime : string ; message? : string ; status : string ; type : string }[] startTime string succeeded number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/batch/v1/jobs\" kind # \u25aa Static kind : string = \"Job\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete (): Promise Returns # Promise Overrides # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getCompletions # \u25b8 getCompletions (): number Returns # number getCondition # \u25b8 getCondition (): Object Returns # Object Name Type lastProbeTime string lastTransitionTime string message? string status string type string getDesiredCompletions # \u25b8 getDesiredCompletions (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getParallelism # \u25b8 getParallelism (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Job > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: Job"},{"location":"extensions/api/classes/renderer.k8sapi.job/#class-job","text":"Renderer . K8sApi .Job","title":"Class: Job"},{"location":"extensions/api/classes/renderer.k8sapi.job/#hierarchy","text":"WorkloadKubeObject \u21b3 Job","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.job/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.job/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.job/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.job/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#constructor","text":"\u2022 new Job ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.job/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.job/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.job/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.job/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.job/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.job/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.job/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.job/#apibase","text":"\u25aa Static apiBase : string = \"/apis/batch/v1/jobs\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.job/#kind_1","text":"\u25aa Static kind : string = \"Job\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.job/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.job/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.job/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.job/#delete","text":"\u25b8 delete (): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getcompletions","text":"\u25b8 getCompletions (): number","title":"getCompletions"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getcondition","text":"\u25b8 getCondition (): Object","title":"getCondition"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getdesiredcompletions","text":"\u25b8 getDesiredCompletions (): number","title":"getDesiredCompletions"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getparallelism","text":"\u25b8 getParallelism (): number","title":"getParallelism"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.job/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.job/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.job/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.job/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.job/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.job/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.job/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.job/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.job/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.job/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.job/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.job/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.job/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.job/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.job/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.job/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/","text":"Class: JobStore # Renderer . K8sApi .JobStore Hierarchy # KubeObjectStore < Job > \u21b3 JobStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new JobStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : JobApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Job > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Job , void, undefined> Returns # Generator < Job , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Job [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Job [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Job Parameters # Name Type id string Returns # Job Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Job [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Job [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Job Parameters # Name Type name string namespace? string Returns # Job Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Job Parameters # Name Type path string Returns # Job Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( job ): Pod [] Parameters # Name Type job Job Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Job [] Returns # Job [] Inherited from # KubeObjectStore . getItems getJobsByOwner # \u25b8 getJobsByOwner ( cronJob ): Job [] Parameters # Name Type cronJob CronJob Returns # Job [] getStatuses # \u25b8 getStatuses ( jobs? ): Object Parameters # Name Type jobs? Job [] Returns # Object Name Type failed number pending number running number succeeded number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Job Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Job [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Job > Parameters # Name Type resourcePath string Returns # Promise < Job > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Job []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Job > Returns # Promise < Job []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Job [] Parameters # Name Type partialItems Job [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Job [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Job > Parameters # Name Type item Job patch Patch Returns # Promise < Job > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Job Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Job request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Job [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Job [] the items to be sorted (default: the current items in this store) sorting ( item : Job ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Job [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Job [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Job > Parameters # Name Type item Job data Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Job > Parameters # Name Type item Job request () => Promise < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . updateItem","title":"Class: JobStore"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#class-jobstore","text":"Renderer . K8sApi .JobStore","title":"Class: JobStore"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#hierarchy","text":"KubeObjectStore < Job > \u21b3 JobStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#constructor","text":"\u2022 new JobStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#api","text":"\u2022 api : JobApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#items","text":"\u2022 items : IObservableArray < Job >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#iterator","text":"\u25b8 [iterator] (): Generator < Job , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#create","text":"\u25b8 create ( params , data? ): Promise < Job >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Job >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Job []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Job []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getbyid","text":"\u25b8 getById ( id ): Job","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Job []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Job","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getbypath","text":"\u25b8 getByPath ( path ): Job","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getchildpods","text":"\u25b8 getChildPods ( job ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getitems","text":"\u25b8 getItems (): Job []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getjobsbyowner","text":"\u25b8 getJobsByOwner ( cronJob ): Job []","title":"getJobsByOwner"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#getstatuses","text":"\u25b8 getStatuses ( jobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#load","text":"\u25b8 load ( params ): Promise < Job >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Job >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Job >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Job []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Job []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Job >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Job [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#update","text":"\u25b8 update ( item , data ): Promise < Job >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.jobstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Job >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/","text":"Class: KubeApi # Renderer . K8sApi .KubeApi Type parameters # Name Type T T : KubeObject Hierarchy # KubeApi \u21b3 PodsApi \u21b3 NodesApi \u21b3 DeploymentApi \u21b3 IngressApi \u21b3 PersistentVolumeClaimsApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new KubeApi ( options ) Type parameters # Name Type T T : KubeObject Parameters # Name Type options IKubeApiOptions Properties # apiBase # \u2022 Readonly apiBase : string apiGroup # \u2022 Readonly apiGroup : string apiPrefix # \u2022 Readonly apiPrefix : string apiResource # \u2022 Readonly apiResource : string apiVersion # \u2022 Readonly apiVersion : string apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string isNamespaced # \u2022 Readonly isNamespaced : boolean kind # \u2022 Readonly kind : string objectConstructor # \u2022 objectConstructor : KubeObjectConstructor options # \u2022 Protected options : IKubeApiOptions request # \u2022 Protected request : KubeJsonApi resourceVersions # \u2022 Protected resourceVersions : Map watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise create # \u25b8 create ( __namedParameters? , data? ): Promise Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial Returns # Promise delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise get # \u25b8 get ( __namedParameters? , query? ): Promise Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string list # \u25b8 list ( __namedParameters? , query? ): Promise Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): T | T [] Parameters # Name Type data unknown namespace? string Returns # T | T [] refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise Parameters # Name Type params? KubeApiListOptions Returns # Promise setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void update # \u25b8 update ( __namedParameters? , data? ): Promise Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial Returns # Promise watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void","title":"Class: KubeApi"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#class-kubeapit","text":"Renderer . K8sApi .KubeApi","title":"Class: KubeApi<T>"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#type-parameters","text":"Name Type T T : KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#hierarchy","text":"KubeApi \u21b3 PodsApi \u21b3 NodesApi \u21b3 DeploymentApi \u21b3 IngressApi \u21b3 PersistentVolumeClaimsApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#constructor","text":"\u2022 new KubeApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor ","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#options","text":"\u2022 Protected options : IKubeApiOptions ","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise ","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise ","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): T | T []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise ","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise ","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.kubeapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/","text":"Class: KubeEvent # Renderer . K8sApi .KubeEvent Hierarchy # KubeObject \u21b3 KubeEvent Table of contents # Constructors # constructor Properties # apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp managedFields message metadata reason reportingComponent reportingInstance source spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeEvent ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion count # \u2022 count : number eventTime # \u2022 eventTime : null firstTimestamp # \u2022 firstTimestamp : string involvedObject # \u2022 involvedObject : Object Type declaration # Name Type apiVersion string fieldPath string kind string name string namespace string resourceVersion string uid string kind # \u2022 kind : string Inherited from # KubeObject . kind lastTimestamp # \u2022 lastTimestamp : string managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields message # \u2022 message : string metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata reason # \u2022 reason : string reportingComponent # \u2022 reportingComponent : string reportingInstance # \u2022 reportingInstance : string source # \u2022 source : Object Type declaration # Name Type component string host string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status type # \u2022 type : string apiBase # \u25aa Static apiBase : string = \"/api/v1/events\" kind # \u25aa Static kind : string = \"Event\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getFirstSeenTime # \u25b8 getFirstSeenTime (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastSeenTime # \u25b8 getLastSeenTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSource # \u25b8 getSource (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow isWarning # \u25b8 isWarning (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < KubeEvent > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: KubeEvent"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#class-kubeevent","text":"Renderer . K8sApi .KubeEvent","title":"Class: KubeEvent"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#hierarchy","text":"KubeObject \u21b3 KubeEvent","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#properties","text":"apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp managedFields message metadata reason reportingComponent reportingInstance source spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#methods","text":"delete getAge getAnnotations getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#constructor","text":"\u2022 new KubeEvent ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#count","text":"\u2022 count : number","title":"count"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#eventtime","text":"\u2022 eventTime : null","title":"eventTime"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#firsttimestamp","text":"\u2022 firstTimestamp : string","title":"firstTimestamp"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#involvedobject","text":"\u2022 involvedObject : Object","title":"involvedObject"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#lasttimestamp","text":"\u2022 lastTimestamp : string","title":"lastTimestamp"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#message","text":"\u2022 message : string","title":"message"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#reason","text":"\u2022 reason : string","title":"reason"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#reportingcomponent","text":"\u2022 reportingComponent : string","title":"reportingComponent"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#reportinginstance","text":"\u2022 reportingInstance : string","title":"reportingInstance"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#source","text":"\u2022 source : Object","title":"source"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#type","text":"\u2022 type : string","title":"type"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/events\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#kind_1","text":"\u25aa Static kind : string = \"Event\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getfirstseentime","text":"\u25b8 getFirstSeenTime (): string","title":"getFirstSeenTime"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getlastseentime","text":"\u25b8 getLastSeenTime (): string","title":"getLastSeenTime"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#getsource","text":"\u25b8 getSource (): string","title":"getSource"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#iswarning","text":"\u25b8 isWarning (): boolean","title":"isWarning"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeevent/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/","text":"Class: KubeObject # Renderer . K8sApi .KubeObject Type parameters # Name Type Metadata Metadata : KubeObjectMetadata = KubeObjectMetadata Status Status = any Spec Spec = any Hierarchy # KubeObject \u21b3 Node \u21b3 CronJob \u21b3 ConfigMap \u21b3 Secret \u21b3 ResourceQuota \u21b3 LimitRange \u21b3 HorizontalPodAutoscaler \u21b3 PodDisruptionBudget \u21b3 Service \u21b3 Endpoint \u21b3 Ingress \u21b3 NetworkPolicy \u21b3 PersistentVolume \u21b3 PersistentVolumeClaim \u21b3 StorageClass \u21b3 Namespace \u21b3 KubeEvent \u21b3 ServiceAccount \u21b3 Role \u21b3 RoleBinding \u21b3 ClusterRole \u21b3 ClusterRoleBinding \u21b3 CustomResourceDefinition Implements # ItemObject Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeObject ( data ) Type parameters # Name Type Metadata Metadata : KubeObjectMetadata = KubeObjectMetadata Status Status = any Spec Spec = any Parameters # Name Type data KubeJsonApiData Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string managedFields # \u2022 Optional managedFields : any metadata # \u2022 metadata : Metadata spec # \u2022 Optional spec : Spec status # \u2022 Optional status : Status kind # \u25aa Static Readonly kind : string namespaced # \u25aa Static Readonly namespaced : boolean Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Implementation of # ItemObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Implementation of # ItemObject.getName getNs # \u25b8 getNs (): string Returns # string getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise toPlainObject # \u25b8 toPlainObject (): object Returns # object update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < KubeObject > Returns # Promise create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string []","title":"Class: KubeObject"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#class-kubeobjectmetadata-status-spec","text":"Renderer . K8sApi .KubeObject","title":"Class: KubeObject<Metadata, Status, Spec>"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#type-parameters","text":"Name Type Metadata Metadata : KubeObjectMetadata = KubeObjectMetadata Status Status = any Spec Spec = any","title":"Type parameters"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#hierarchy","text":"KubeObject \u21b3 Node \u21b3 CronJob \u21b3 ConfigMap \u21b3 Secret \u21b3 ResourceQuota \u21b3 LimitRange \u21b3 HorizontalPodAutoscaler \u21b3 PodDisruptionBudget \u21b3 Service \u21b3 Endpoint \u21b3 Ingress \u21b3 NetworkPolicy \u21b3 PersistentVolume \u21b3 PersistentVolumeClaim \u21b3 StorageClass \u21b3 Namespace \u21b3 KubeEvent \u21b3 ServiceAccount \u21b3 Role \u21b3 RoleBinding \u21b3 ClusterRole \u21b3 ClusterRoleBinding \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#implements","text":"ItemObject","title":"Implements"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#properties","text":"apiVersion kind managedFields metadata spec status kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#constructor","text":"\u2022 new KubeObject ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#spec","text":"\u2022 Optional spec : Spec","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#kind_1","text":"\u25aa Static Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#namespaced","text":"\u25aa Static Readonly namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobject/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/","text":"Class: KubeObjectStore # Renderer . K8sApi .KubeObjectStore Type parameters # Name Type T T : KubeObject Hierarchy # ItemStore \u21b3 KubeObjectStore \u21b3\u21b3 EventStore \u21b3\u21b3 PodsStore \u21b3\u21b3 NodesStore \u21b3\u21b3 DeploymentStore \u21b3\u21b3 DaemonSetStore \u21b3\u21b3 StatefulSetStore \u21b3\u21b3 JobStore \u21b3\u21b3 CronJobStore \u21b3\u21b3 ConfigMapsStore \u21b3\u21b3 SecretsStore \u21b3\u21b3 ReplicaSetStore \u21b3\u21b3 ResourceQuotasStore \u21b3\u21b3 LimitRangesStore \u21b3\u21b3 HPAStore \u21b3\u21b3 PodDisruptionBudgetsStore \u21b3\u21b3 ServiceStore \u21b3\u21b3 EndpointStore \u21b3\u21b3 IngressStore \u21b3\u21b3 NetworkPolicyStore \u21b3\u21b3 PersistentVolumesStore \u21b3\u21b3 VolumeClaimStore \u21b3\u21b3 StorageClassStore \u21b3\u21b3 NamespaceStore \u21b3\u21b3 ServiceAccountsStore \u21b3\u21b3 RolesStore \u21b3\u21b3 RoleBindingsStore \u21b3\u21b3 CRDStore \u21b3\u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore ( api? ) Type parameters # Name Type T T : KubeObject Parameters # Name Type api? KubeApi Overrides # ItemStore.constructor Properties # api # \u2022 api : KubeApi bufferSize # \u2022 Readonly bufferSize : number = 50000 eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > failedLoading # \u2022 failedLoading : boolean = false Inherited from # ItemStore.failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # ItemStore.isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # ItemStore.isLoading items # \u2022 items : IObservableArray Inherited from # ItemStore.items limit # \u2022 Optional Readonly limit : number selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # ItemStore.selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator Returns # Generator Inherited from # ItemStore.__@iterator@599 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void create # \u25b8 create ( params , data? ): Promise Parameters # Name Type params Object params.name string params.namespace? string data? Partial Returns # Promise createItem # \u25b8 Protected createItem ( params , data? ): Promise Parameters # Name Type params Object params.name string params.namespace? string data? Partial Returns # Promise Overrides # ItemStore.createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # ItemStore.defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): T [] Parameters # Name Type items T [] Returns # T [] getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): T [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # T [] getById # \u25b8 getById ( id ): T Parameters # Name Type id string Returns # T getByLabel # \u25b8 getByLabel ( labels ): T [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # T [] getByName # \u25b8 getByName ( name , namespace? ): T Parameters # Name Type name string namespace? string Returns # T Overrides # ItemStore.getByName getByPath # \u25b8 getByPath ( path ): T Parameters # Name Type path string Returns # T getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # ItemStore.getIndexById getItems # \u25b8 getItems (): T [] Returns # T [] Inherited from # ItemStore.getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items T [] Returns # Record getTotalCount # \u25b8 getTotalCount (): number Returns # number Overrides # ItemStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item T Returns # boolean Inherited from # ItemStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems T [] Returns # boolean Inherited from # ItemStore.isSelectedAll load # \u25b8 load ( params ): Promise Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Overrides # ItemStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise Parameters # Name Type resourcePath string Returns # Promise loadItem # \u25b8 Protected loadItem ( params ): Promise Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise Overrides # ItemStore.loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise Overrides # ItemStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): T [] Parameters # Name Type partialItems T [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # T [] patch # \u25b8 patch ( item , patch ): Promise Parameters # Name Type item T patch Patch Returns # Promise reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise remove # \u25b8 remove ( item ): Promise Parameters # Name Type item T Returns # Promise removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item T request () => Promise Returns # Promise Inherited from # ItemStore.removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Overrides # ItemStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # ItemStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # ItemStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): T [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items T [] the items to be sorted (default: the current items in this store) sorting ( item : T ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # T [] Inherited from # ItemStore.sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems T [] Returns # void Inherited from # ItemStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.unselect update # \u25b8 update ( item , data ): Promise Parameters # Name Type item T data Partial Returns # Promise updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void updateItem # \u25b8 Protected updateItem ( item , request ): Promise Parameters # Name Type item T request () => Promise Returns # Promise Inherited from # ItemStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#class-kubeobjectstoret","text":"Renderer . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<T>"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#type-parameters","text":"Name Type T T : KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#hierarchy","text":"ItemStore \u21b3 KubeObjectStore \u21b3\u21b3 EventStore \u21b3\u21b3 PodsStore \u21b3\u21b3 NodesStore \u21b3\u21b3 DeploymentStore \u21b3\u21b3 DaemonSetStore \u21b3\u21b3 StatefulSetStore \u21b3\u21b3 JobStore \u21b3\u21b3 CronJobStore \u21b3\u21b3 ConfigMapsStore \u21b3\u21b3 SecretsStore \u21b3\u21b3 ReplicaSetStore \u21b3\u21b3 ResourceQuotasStore \u21b3\u21b3 LimitRangesStore \u21b3\u21b3 HPAStore \u21b3\u21b3 PodDisruptionBudgetsStore \u21b3\u21b3 ServiceStore \u21b3\u21b3 EndpointStore \u21b3\u21b3 IngressStore \u21b3\u21b3 NetworkPolicyStore \u21b3\u21b3 PersistentVolumesStore \u21b3\u21b3 VolumeClaimStore \u21b3\u21b3 StorageClassStore \u21b3\u21b3 NamespaceStore \u21b3\u21b3 ServiceAccountsStore \u21b3\u21b3 RolesStore \u21b3\u21b3 RoleBindingsStore \u21b3\u21b3 CRDStore \u21b3\u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#constructor","text":"\u2022 new KubeObjectStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#api","text":"\u2022 api : KubeApi ","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#items","text":"\u2022 items : IObservableArray ","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#iterator","text":"\u25b8 [iterator] (): Generator ","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#create","text":"\u25b8 create ( params , data? ): Promise ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise ","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): T []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): T []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getbyid","text":"\u25b8 getById ( id ): T","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): T []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): T","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getbypath","text":"\u25b8 getByPath ( path ): T","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getitems","text":"\u25b8 getItems (): T []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#load","text":"\u25b8 load ( params ): Promise ","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise ","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise ","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise ","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): T []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#patch","text":"\u25b8 patch ( item , patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): T [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#update","text":"\u25b8 update ( item , data ): Promise ","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.kubeobjectstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise ","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/","text":"Class: LimitRange # Renderer . K8sApi .LimitRange Hierarchy # KubeObject \u21b3 LimitRange Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getContainerLimits getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new LimitRange ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type limits LimitRangeItem [] Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/limitranges\" kind # \u25aa Static kind : string = \"LimitRange\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getContainerLimits # \u25b8 getContainerLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPVCLimits # \u25b8 getPVCLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getPodLimits # \u25b8 getPodLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < LimitRange > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: LimitRange"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#class-limitrange","text":"Renderer . K8sApi .LimitRange","title":"Class: LimitRange"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#hierarchy","text":"KubeObject \u21b3 LimitRange","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#methods","text":"delete getAge getAnnotations getContainerLimits getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#constructor","text":"\u2022 new LimitRange ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/limitranges\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#kind_1","text":"\u25aa Static kind : string = \"LimitRange\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getcontainerlimits","text":"\u25b8 getContainerLimits (): LimitRangeItem []","title":"getContainerLimits"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getpvclimits","text":"\u25b8 getPVCLimits (): LimitRangeItem []","title":"getPVCLimits"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getpodlimits","text":"\u25b8 getPodLimits (): LimitRangeItem []","title":"getPodLimits"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.limitrange/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/","text":"Class: LimitRangesStore # Renderer . K8sApi .LimitRangesStore Hierarchy # KubeObjectStore < LimitRange > \u21b3 LimitRangesStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new LimitRangesStore ( api? ) Parameters # Name Type api? KubeApi < LimitRange > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < LimitRange > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < LimitRange > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < LimitRange , void, undefined> Returns # Generator < LimitRange , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): LimitRange [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # LimitRange [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): LimitRange Parameters # Name Type id string Returns # LimitRange Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): LimitRange [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # LimitRange [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): LimitRange Parameters # Name Type name string namespace? string Returns # LimitRange Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): LimitRange Parameters # Name Type path string Returns # LimitRange Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items LimitRange [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item LimitRange Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems LimitRange [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < LimitRange > Parameters # Name Type resourcePath string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < LimitRange []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < LimitRange > Returns # Promise < LimitRange []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): LimitRange [] Parameters # Name Type partialItems LimitRange [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # LimitRange [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < LimitRange > Parameters # Name Type item LimitRange patch Patch Returns # Promise < LimitRange > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item LimitRange Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item LimitRange request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): LimitRange [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items LimitRange [] the items to be sorted (default: the current items in this store) sorting ( item : LimitRange ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # LimitRange [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems LimitRange [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < LimitRange > Parameters # Name Type item LimitRange data Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < LimitRange > Parameters # Name Type item LimitRange request () => Promise < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . updateItem","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#class-limitrangesstore","text":"Renderer . K8sApi .LimitRangesStore","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#hierarchy","text":"KubeObjectStore < LimitRange > \u21b3 LimitRangesStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#constructor","text":"\u2022 new LimitRangesStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#api","text":"\u2022 api : KubeApi < LimitRange >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#items","text":"\u2022 items : IObservableArray < LimitRange >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#iterator","text":"\u25b8 [iterator] (): Generator < LimitRange , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#create","text":"\u25b8 create ( params , data? ): Promise < LimitRange >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < LimitRange >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): LimitRange []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): LimitRange []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getbyid","text":"\u25b8 getById ( id ): LimitRange","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): LimitRange []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): LimitRange","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getbypath","text":"\u25b8 getByPath ( path ): LimitRange","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getitems","text":"\u25b8 getItems (): LimitRange []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#load","text":"\u25b8 load ( params ): Promise < LimitRange >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < LimitRange >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < LimitRange >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < LimitRange []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): LimitRange []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < LimitRange >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): LimitRange [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#update","text":"\u25b8 update ( item , data ): Promise < LimitRange >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.limitrangesstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < LimitRange >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/","text":"Class: Namespace # Renderer . K8sApi .Namespace Hierarchy # KubeObject \u21b3 Namespace Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Namespace ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : Object Type declaration # Name Type phase string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/namespaces\" kind # \u25aa Static kind : string = \"Namespace\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Namespace > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Namespace"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#class-namespace","text":"Renderer . K8sApi .Namespace","title":"Class: Namespace"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#hierarchy","text":"KubeObject \u21b3 Namespace","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#constructor","text":"\u2022 new Namespace ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#status","text":"\u2022 Optional status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/namespaces\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#kind_1","text":"\u25aa Static kind : string = \"Namespace\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.namespace/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/","text":"Class: NamespaceStore # Renderer . K8sApi .NamespaceStore Hierarchy # KubeObjectStore < Namespace > \u21b3 NamespaceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # allowedNamespaces context contextItems contextNamespaces contextReady hasAllContexts namespacesReady query selectedItems selectedNamespaces Methods # [iterator] bindWatchEventsUpdater clearSelected create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select selectNamespaces sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NamespaceStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : NamespaceApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Namespace > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # allowedNamespaces # \u2022 get allowedNamespaces (): string [] Returns # string [] context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextNamespaces # \u2022 get contextNamespaces (): string [] Returns # string [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } hasAllContexts # \u2022 get hasAllContexts (): boolean Returns # boolean namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] selectedNamespaces # \u2022 get selectedNamespaces (): string [] Returns # string [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Namespace , void, undefined> Returns # Generator < Namespace , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater clearSelected # \u25b8 clearSelected ( namespaces? ): void Parameters # Name Type namespaces? string | string [] Returns # void create # \u25b8 create ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Namespace [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Namespace [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Namespace Parameters # Name Type id string Returns # Namespace Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Namespace [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Namespace [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Namespace Parameters # Name Type name string namespace? string Returns # Namespace Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Namespace Parameters # Name Type path string Returns # Namespace Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Namespace [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount hasContext # \u25b8 hasContext ( namespaces ): boolean Parameters # Name Type namespaces string | string [] Returns # boolean isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Namespace Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Namespace [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Namespace > Parameters # Name Type resourcePath string Returns # Promise < Namespace > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( params ): Promise < Namespace []> Parameters # Name Type params KubeObjectStoreLoadingParams < Namespace > Returns # Promise < Namespace []> Overrides # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Namespace [] Parameters # Name Type partialItems Namespace [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Namespace [] Inherited from # KubeObjectStore . mergeItems onContextChange # \u25b8 onContextChange ( callback , opts? ): IReactionDisposer Parameters # Name Type callback ( namespaces : string []) => void opts IReactionOptions Returns # IReactionDisposer patch # \u25b8 patch ( item , patch ): Promise < Namespace > Parameters # Name Type item Namespace patch Patch Returns # Promise < Namespace > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Namespace Returns # Promise Overrides # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Namespace request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . select selectNamespaces # \u25b8 selectNamespaces ( namespace ): void Parameters # Name Type namespace string | string [] Returns # void sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Namespace [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Namespace [] the items to be sorted (default: the current items in this store) sorting ( item : Namespace ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Namespace [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): (... args : T ) => void Returns # fn \u25b8 (... args ): void A function that does nothing Type parameters # Name Type T T : any [] Parameters # Name Type ...args T Returns # void Overrides # KubeObjectStore . subscribe toggleAll # \u25b8 toggleAll ( showAll? ): void Parameters # Name Type showAll? boolean Returns # void toggleContext # \u25b8 toggleContext ( namespaces ): void Parameters # Name Type namespaces string | string [] Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Namespace [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll toggleSingle # \u25b8 toggleSingle ( namespace ): void Parameters # Name Type namespace string Returns # void unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Namespace > Parameters # Name Type item Namespace data Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Namespace > Parameters # Name Type item Namespace request () => Promise < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . updateItem","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#class-namespacestore","text":"Renderer . K8sApi .NamespaceStore","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#hierarchy","text":"KubeObjectStore < Namespace > \u21b3 NamespaceStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#accessors","text":"allowedNamespaces context contextItems contextNamespaces contextReady hasAllContexts namespacesReady query selectedItems selectedNamespaces","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#methods","text":"[iterator] bindWatchEventsUpdater clearSelected create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select selectNamespaces sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#constructor","text":"\u2022 new NamespaceStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#api","text":"\u2022 api : NamespaceApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#items","text":"\u2022 items : IObservableArray < Namespace >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#allowednamespaces","text":"\u2022 get allowedNamespaces (): string []","title":"allowedNamespaces"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#contextnamespaces","text":"\u2022 get contextNamespaces (): string []","title":"contextNamespaces"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#hasallcontexts","text":"\u2022 get hasAllContexts (): boolean","title":"hasAllContexts"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#selectednamespaces","text":"\u2022 get selectedNamespaces (): string []","title":"selectedNamespaces"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#iterator","text":"\u25b8 [iterator] (): Generator < Namespace , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#clearselected","text":"\u25b8 clearSelected ( namespaces? ): void","title":"clearSelected"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#create","text":"\u25b8 create ( params , data? ): Promise < Namespace >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Namespace >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Namespace []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Namespace []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getbyid","text":"\u25b8 getById ( id ): Namespace","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Namespace []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Namespace","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getbypath","text":"\u25b8 getByPath ( path ): Namespace","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getitems","text":"\u25b8 getItems (): Namespace []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#hascontext","text":"\u25b8 hasContext ( namespaces ): boolean","title":"hasContext"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#load","text":"\u25b8 load ( params ): Promise < Namespace >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Namespace >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Namespace >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#loaditems","text":"\u25b8 Protected loadItems ( params ): Promise < Namespace []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Namespace []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#oncontextchange","text":"\u25b8 onContextChange ( callback , opts? ): IReactionDisposer","title":"onContextChange"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Namespace >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#selectnamespaces","text":"\u25b8 selectNamespaces ( namespace ): void","title":"selectNamespaces"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Namespace [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#subscribe","text":"\u25b8 subscribe (): (... args : T ) => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#toggleall","text":"\u25b8 toggleAll ( showAll? ): void","title":"toggleAll"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#togglecontext","text":"\u25b8 toggleContext ( namespaces ): void","title":"toggleContext"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#togglesingle","text":"\u25b8 toggleSingle ( namespace ): void","title":"toggleSingle"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#update","text":"\u25b8 update ( item , data ): Promise < Namespace >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.namespacestore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Namespace >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/","text":"Class: NetworkPolicy # Renderer . K8sApi .NetworkPolicy Hierarchy # KubeObject \u21b3 NetworkPolicy Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new NetworkPolicy ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type egress IPolicyEgress [] ingress IPolicyIngress [] podSelector Object podSelector.matchLabels Object podSelector.matchLabels.role string policyTypes string [] Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/networkpolicies\" kind # \u25aa Static kind : string = \"NetworkPolicy\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTypes # \u25b8 getTypes (): string [] Returns # string [] patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < NetworkPolicy > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#class-networkpolicy","text":"Renderer . K8sApi .NetworkPolicy","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#hierarchy","text":"KubeObject \u21b3 NetworkPolicy","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#constructor","text":"\u2022 new NetworkPolicy ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#apibase","text":"\u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/networkpolicies\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#kind_1","text":"\u25aa Static kind : string = \"NetworkPolicy\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#gettypes","text":"\u25b8 getTypes (): string []","title":"getTypes"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicy/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/","text":"Class: NetworkPolicyStore # Renderer . K8sApi .NetworkPolicyStore Hierarchy # KubeObjectStore < NetworkPolicy > \u21b3 NetworkPolicyStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NetworkPolicyStore ( api? ) Parameters # Name Type api? KubeApi < NetworkPolicy > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < NetworkPolicy > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < NetworkPolicy > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < NetworkPolicy , void, undefined> Returns # Generator < NetworkPolicy , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy [] Parameters # Name Type items NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # NetworkPolicy [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): NetworkPolicy Parameters # Name Type id string Returns # NetworkPolicy Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): NetworkPolicy [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # NetworkPolicy [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): NetworkPolicy Parameters # Name Type name string namespace? string Returns # NetworkPolicy Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): NetworkPolicy Parameters # Name Type path string Returns # NetworkPolicy Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items NetworkPolicy [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item NetworkPolicy Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems NetworkPolicy [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy > Parameters # Name Type resourcePath string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < NetworkPolicy []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < NetworkPolicy > Returns # Promise < NetworkPolicy []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): NetworkPolicy [] Parameters # Name Type partialItems NetworkPolicy [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # NetworkPolicy [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy patch Patch Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item NetworkPolicy Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item NetworkPolicy request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): NetworkPolicy [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items NetworkPolicy [] the items to be sorted (default: the current items in this store) sorting ( item : NetworkPolicy ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # NetworkPolicy [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems NetworkPolicy [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy data Partial < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy request () => Promise < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore . updateItem","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#class-networkpolicystore","text":"Renderer . K8sApi .NetworkPolicyStore","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#hierarchy","text":"KubeObjectStore < NetworkPolicy > \u21b3 NetworkPolicyStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#constructor","text":"\u2022 new NetworkPolicyStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#api","text":"\u2022 api : KubeApi < NetworkPolicy >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#items","text":"\u2022 items : IObservableArray < NetworkPolicy >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#iterator","text":"\u25b8 [iterator] (): Generator < NetworkPolicy , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#create","text":"\u25b8 create ( params , data? ): Promise < NetworkPolicy >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < NetworkPolicy >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getbyid","text":"\u25b8 getById ( id ): NetworkPolicy","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getbylabel","text":"\u25b8 getByLabel ( labels ): NetworkPolicy []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): NetworkPolicy","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getbypath","text":"\u25b8 getByPath ( path ): NetworkPolicy","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getitems","text":"\u25b8 getItems (): NetworkPolicy []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#load","text":"\u25b8 load ( params ): Promise < NetworkPolicy >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < NetworkPolicy >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < NetworkPolicy []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): NetworkPolicy []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#patch","text":"\u25b8 patch ( item , patch ): Promise < NetworkPolicy >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): NetworkPolicy [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#update","text":"\u25b8 update ( item , data ): Promise < NetworkPolicy >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.networkpolicystore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.node/","text":"Class: Node # Renderer . K8sApi .Node Hierarchy # KubeObject \u21b3 Node Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabels getSearchFields getTaints getTimeDiffFromNow getWarningConditions isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Node ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type externalID? string podCIDR? string podCIDRs? string [] providerID? string taints? { effect : string ; key : string ; timeAdded : string ; value : string }[] unschedulable? boolean Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type addresses? { address : string ; type : string }[] allocatable? Object allocatable.cpu string allocatable.ephemeral-storage string allocatable.hugepages-1Gi string allocatable.hugepages-2Mi string allocatable.memory string allocatable.pods string capacity? Object capacity.cpu string capacity.ephemeral-storage string capacity.hugepages-1Gi string capacity.hugepages-2Mi string capacity.memory string capacity.pods string conditions? { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] daemonEndpoints? Object daemonEndpoints.kubeletEndpoint Object daemonEndpoints.kubeletEndpoint.Port number images? { names : string [] ; sizeBytes? : number }[] nodeInfo? Object nodeInfo.architecture string nodeInfo.bootID string nodeInfo.containerRuntimeVersion string nodeInfo.kernelVersion string nodeInfo.kubeProxyVersion string nodeInfo.kubeletVersion string nodeInfo.machineID string nodeInfo.operatingSystem string nodeInfo.osImage string nodeInfo.systemUUID string volumesAttached? { devicePath : string ; name : string }[] volumesInUse? string [] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/nodes\" kind # \u25aa Static kind : string = \"Node\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getActiveConditions # \u25b8 getActiveConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] Returns # { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] Returns # { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] getCpuCapacity # \u25b8 getCpuCapacity (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKubeletVersion # \u25b8 getKubeletVersion (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMemoryCapacity # \u25b8 getMemoryCapacity (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeConditionText # \u25b8 getNodeConditionText (): string Returns # string getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOperatingSystem # \u25b8 getOperatingSystem (): string Returns # string getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoleLabels # \u25b8 getRoleLabels (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTaints # \u25b8 getTaints (): { effect : string ; key : string ; timeAdded : string ; value : string }[] Returns # { effect : string ; key : string ; timeAdded : string ; value : string }[] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getWarningConditions # \u25b8 getWarningConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] Returns # { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[] isUnschedulable # \u25b8 isUnschedulable (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Node > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Node"},{"location":"extensions/api/classes/renderer.k8sapi.node/#class-node","text":"Renderer . K8sApi .Node","title":"Class: Node"},{"location":"extensions/api/classes/renderer.k8sapi.node/#hierarchy","text":"KubeObject \u21b3 Node","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.node/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.node/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.node/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.node/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.node/#methods","text":"delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabels getSearchFields getTaints getTimeDiffFromNow getWarningConditions isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.node/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.node/#constructor","text":"\u2022 new Node ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.node/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.node/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.node/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.node/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.node/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.node/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.node/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.node/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/nodes\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.node/#kind_1","text":"\u25aa Static kind : string = \"Node\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.node/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.node/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.node/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.node/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.node/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getactiveconditions","text":"\u25b8 getActiveConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[]","title":"getActiveConditions"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getconditions","text":"\u25b8 getConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getcpucapacity","text":"\u25b8 getCpuCapacity (): number","title":"getCpuCapacity"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getkubeletversion","text":"\u25b8 getKubeletVersion (): string","title":"getKubeletVersion"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getmemorycapacity","text":"\u25b8 getMemoryCapacity (): number","title":"getMemoryCapacity"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getnodeconditiontext","text":"\u25b8 getNodeConditionText (): string","title":"getNodeConditionText"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getoperatingsystem","text":"\u25b8 getOperatingSystem (): string","title":"getOperatingSystem"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getrolelabels","text":"\u25b8 getRoleLabels (): string","title":"getRoleLabels"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.node/#gettaints","text":"\u25b8 getTaints (): { effect : string ; key : string ; timeAdded : string ; value : string }[]","title":"getTaints"},{"location":"extensions/api/classes/renderer.k8sapi.node/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.node/#getwarningconditions","text":"\u25b8 getWarningConditions (): { lastHeartbeatTime? : string ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : string ; type : string }[]","title":"getWarningConditions"},{"location":"extensions/api/classes/renderer.k8sapi.node/#isunschedulable","text":"\u25b8 isUnschedulable (): boolean","title":"isUnschedulable"},{"location":"extensions/api/classes/renderer.k8sapi.node/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.node/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.node/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.node/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.node/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.node/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.node/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.node/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.node/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.node/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.node/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.node/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/","text":"Class: NodesApi # Renderer . K8sApi .NodesApi Hierarchy # KubeApi < Node > \u21b3 NodesApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new NodesApi ( options ) Parameters # Name Type options IKubeApiOptions < Node > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Node > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Node > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Node > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Node > Returns # Promise < Node > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Node > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise < Node > Inherited from # KubeApi . get getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Node []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Node []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Node | Node [] Parameters # Name Type data unknown namespace? string Returns # Node | Node [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Node []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Node []> Inherited from # KubeApi . refreshResourceVersion setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Node > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Node > Returns # Promise < Node > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: NodesApi"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#class-nodesapi","text":"Renderer . K8sApi .NodesApi","title":"Class: NodesApi"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#hierarchy","text":"KubeApi < Node > \u21b3 NodesApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#constructor","text":"\u2022 new NodesApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Node >","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#options","text":"\u2022 Protected options : IKubeApiOptions < Node >","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Node >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Node >","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Node []>","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Node | Node []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Node []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Node >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.nodesapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/","text":"Class: NodesStore # Renderer . K8sApi .NodesStore Hierarchy # KubeObjectStore < Node > \u21b3 NodesStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady masterNodes namespacesReady query selectedItems workerNodes Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NodesStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : NodesApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Node > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } masterNodes # \u2022 get masterNodes (): Node [] Returns # Node [] namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] workerNodes # \u2022 get workerNodes (): Node [] Returns # Node [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Node , void, undefined> Returns # Generator < Node , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Node > Returns # Promise < Node > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Node > Returns # Promise < Node > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Node [] Parameters # Name Type items Node [] Returns # Node [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Node [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Node [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Node Parameters # Name Type id string Returns # Node Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Node [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Node [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Node Parameters # Name Type name string namespace? string Returns # Node Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Node Parameters # Name Type path string Returns # Node Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Node [] Returns # Node [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Node [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Node Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Node [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Node > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Node > Parameters # Name Type resourcePath string Returns # Promise < Node > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Node > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Node []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Node > Returns # Promise < Node []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Node [] Parameters # Name Type partialItems Node [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Node [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Node > Parameters # Name Type item Node patch Patch Returns # Promise < Node > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Node Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Node request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Node [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Node [] the items to be sorted (default: the current items in this store) sorting ( item : Node ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Node [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Node [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Node > Parameters # Name Type item Node data Partial < Node > Returns # Promise < Node > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Node > Parameters # Name Type item Node request () => Promise < Node > Returns # Promise < Node > Inherited from # KubeObjectStore . updateItem","title":"Class: NodesStore"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#class-nodesstore","text":"Renderer . K8sApi .NodesStore","title":"Class: NodesStore"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#hierarchy","text":"KubeObjectStore < Node > \u21b3 NodesStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#accessors","text":"context contextItems contextReady masterNodes namespacesReady query selectedItems workerNodes","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#constructor","text":"\u2022 new NodesStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#api","text":"\u2022 api : NodesApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#items","text":"\u2022 items : IObservableArray < Node >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#masternodes","text":"\u2022 get masterNodes (): Node []","title":"masterNodes"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#workernodes","text":"\u2022 get workerNodes (): Node []","title":"workerNodes"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#iterator","text":"\u25b8 [iterator] (): Generator < Node , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#create","text":"\u25b8 create ( params , data? ): Promise < Node >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Node >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Node []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Node []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getbyid","text":"\u25b8 getById ( id ): Node","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Node []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Node","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getbypath","text":"\u25b8 getByPath ( path ): Node","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getitems","text":"\u25b8 getItems (): Node []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#load","text":"\u25b8 load ( params ): Promise < Node >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Node >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Node >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Node []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Node []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Node >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Node [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#update","text":"\u25b8 update ( item , data ): Promise < Node >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.nodesstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Node >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/","text":"Class: PersistentVolume # Renderer . K8sApi .PersistentVolume Hierarchy # KubeObject \u21b3 PersistentVolume Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCapacity getClaimRefName getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolume ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type accessModes string [] capacity Object capacity.storage string claimRef Object claimRef.apiVersion string claimRef.kind string claimRef.name string claimRef.namespace string claimRef.resourceVersion string claimRef.uid string flexVolume Object flexVolume.driver string flexVolume.options Object flexVolume.options.clusterNamespace string flexVolume.options.image string flexVolume.options.pool string flexVolume.options.storageClass string mountOptions? string [] nfs? Object nfs.path string nfs.server string persistentVolumeReclaimPolicy string storageClassName string Inherited from # KubeObject . spec status # \u2022 Optional status : Object Type declaration # Name Type phase string reason? string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/persistentvolumes\" kind # \u25aa Static kind : string = \"PersistentVolume\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getCapacity # \u25b8 getCapacity ( inBytes? ): string | number Parameters # Name Type Default value inBytes boolean false Returns # string | number getClaimRefName # \u25b8 getClaimRefName (): string Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorageClass # \u25b8 getStorageClass (): string Returns # string getStorageClassName # \u25b8 getStorageClassName (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < PersistentVolume > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#class-persistentvolume","text":"Renderer . K8sApi .PersistentVolume","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#hierarchy","text":"KubeObject \u21b3 PersistentVolume","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#methods","text":"delete getAge getAnnotations getCapacity getClaimRefName getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#constructor","text":"\u2022 new PersistentVolume ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#status","text":"\u2022 Optional status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/persistentvolumes\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#kind_1","text":"\u25aa Static kind : string = \"PersistentVolume\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getcapacity","text":"\u25b8 getCapacity ( inBytes? ): string | number","title":"getCapacity"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getclaimrefname","text":"\u25b8 getClaimRefName (): string","title":"getClaimRefName"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getstorageclass","text":"\u25b8 getStorageClass (): string","title":"getStorageClass"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#getstorageclassname","text":"\u25b8 getStorageClassName (): string","title":"getStorageClassName"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolume/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/","text":"Class: PersistentVolumeClaim # Renderer . K8sApi .PersistentVolumeClaim Hierarchy # KubeObject \u21b3 PersistentVolumeClaim Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolumeClaim ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type accessModes string [] resources Object resources.requests Object resources.requests.storage string selector Object selector.matchExpressions { key : string ; operator : string ; values : string [] }[] selector.matchLabels Object selector.matchLabels.release string storageClassName string Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type phase string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/persistentvolumeclaims\" kind # \u25aa Static kind : string = \"PersistentVolumeClaim\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchExpressions # \u25b8 getMatchExpressions (): { key : string ; operator : string ; values : string [] }[] Returns # { key : string ; operator : string ; values : string [] }[] getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPods # \u25b8 getPods ( allPods ): Pod [] Parameters # Name Type allPods Pod [] Returns # Pod [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorage # \u25b8 getStorage (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < PersistentVolumeClaim > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#class-persistentvolumeclaim","text":"Renderer . K8sApi .PersistentVolumeClaim","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#hierarchy","text":"KubeObject \u21b3 PersistentVolumeClaim","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#constructor","text":"\u2022 new PersistentVolumeClaim ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/persistentvolumeclaims\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#kind_1","text":"\u25aa Static kind : string = \"PersistentVolumeClaim\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getmatchexpressions","text":"\u25b8 getMatchExpressions (): { key : string ; operator : string ; values : string [] }[]","title":"getMatchExpressions"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getpods","text":"\u25b8 getPods ( allPods ): Pod []","title":"getPods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#getstorage","text":"\u25b8 getStorage (): string","title":"getStorage"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/","text":"Class: PersistentVolumeClaimsApi # Renderer . K8sApi .PersistentVolumeClaimsApi Hierarchy # KubeApi < PersistentVolumeClaim > \u21b3 PersistentVolumeClaimsApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new PersistentVolumeClaimsApi ( options ) Parameters # Name Type options IKubeApiOptions < PersistentVolumeClaim > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < PersistentVolumeClaim > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < PersistentVolumeClaim > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < PersistentVolumeClaim > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise < PersistentVolumeClaim > Inherited from # KubeApi . get getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < PersistentVolumeClaim []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < PersistentVolumeClaim []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): PersistentVolumeClaim | PersistentVolumeClaim [] Parameters # Name Type data unknown namespace? string Returns # PersistentVolumeClaim | PersistentVolumeClaim [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < PersistentVolumeClaim []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < PersistentVolumeClaim []> Inherited from # KubeApi . refreshResourceVersion setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: PersistentVolumeClaimsApi"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#class-persistentvolumeclaimsapi","text":"Renderer . K8sApi .PersistentVolumeClaimsApi","title":"Class: PersistentVolumeClaimsApi"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#hierarchy","text":"KubeApi < PersistentVolumeClaim > \u21b3 PersistentVolumeClaimsApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#constructor","text":"\u2022 new PersistentVolumeClaimsApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < PersistentVolumeClaim >","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#options","text":"\u2022 Protected options : IKubeApiOptions < PersistentVolumeClaim >","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < PersistentVolumeClaim >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < PersistentVolumeClaim >","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < PersistentVolumeClaim []>","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): PersistentVolumeClaim | PersistentVolumeClaim []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < PersistentVolumeClaim []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < PersistentVolumeClaim >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/","text":"Class: PersistentVolumesStore # Renderer . K8sApi .PersistentVolumesStore Hierarchy # KubeObjectStore < PersistentVolume > \u21b3 PersistentVolumesStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PersistentVolumesStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < PersistentVolume > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < PersistentVolume > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolume , void, undefined> Returns # Generator < PersistentVolume , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume [] Parameters # Name Type items PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolume [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # PersistentVolume [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): PersistentVolume Parameters # Name Type id string Returns # PersistentVolume Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolume [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # PersistentVolume [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): PersistentVolume Parameters # Name Type name string namespace? string Returns # PersistentVolume Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): PersistentVolume Parameters # Name Type path string Returns # PersistentVolume Inherited from # KubeObjectStore . getByPath getByStorageClass # \u25b8 getByStorageClass ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items PersistentVolume [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolume Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems PersistentVolume [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < PersistentVolume []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < PersistentVolume > Returns # Promise < PersistentVolume []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PersistentVolume [] Parameters # Name Type partialItems PersistentVolume [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # PersistentVolume [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume patch Patch Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item PersistentVolume Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item PersistentVolume request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): PersistentVolume [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items PersistentVolume [] the items to be sorted (default: the current items in this store) sorting ( item : PersistentVolume ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # PersistentVolume [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems PersistentVolume [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume data Partial < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume request () => Promise < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore . updateItem","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#class-persistentvolumesstore","text":"Renderer . K8sApi .PersistentVolumesStore","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#hierarchy","text":"KubeObjectStore < PersistentVolume > \u21b3 PersistentVolumesStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#constructor","text":"\u2022 new PersistentVolumesStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#api","text":"\u2022 api : KubeApi < PersistentVolume >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#items","text":"\u2022 items : IObservableArray < PersistentVolume >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolume , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolume >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < PersistentVolume >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolume []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getbyid","text":"\u25b8 getById ( id ): PersistentVolume","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolume []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): PersistentVolume","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getbypath","text":"\u25b8 getByPath ( path ): PersistentVolume","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getbystorageclass","text":"\u25b8 getByStorageClass ( storageClass ): PersistentVolume []","title":"getByStorageClass"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getitems","text":"\u25b8 getItems (): PersistentVolume []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolume >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < PersistentVolume >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < PersistentVolume []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PersistentVolume []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolume >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): PersistentVolume [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolume >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.persistentvolumesstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.pod/","text":"Class: Pod # Renderer . K8sApi .Pod Hierarchy # WorkloadKubeObject \u21b3 Pod Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getProbe getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getSearchFields getSecrets getSelectedNodeOs getSelectors getStartupProbe getStatus getStatusMessage getStatusPhase getTemplateLabels getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Pod ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 Optional spec : Object Type declaration # Name Type activeDeadlineSeconds? number affinity? IAffinity automountServiceAccountToken? boolean containers IPodContainer [] dnsPolicy? string hostAliases? Object hostAliases.hostnames string [] hostAliases.ip string hostIPC? boolean hostNetwork? boolean hostPID? boolean hostname? string imagePullSecrets? { name : string }[] 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? { effect? : string ; key? : string ; operator? : string ; tolerationSeconds? : number ; value? : string }[] volumes? { configMap : { name : string } ; emptyDir : { medium? : string ; sizeLimit? : string } ; name : string ; persistentVolumeClaim : { claimName : string } ; secret : { defaultMode : number ; secretName : string } }[] Overrides # WorkloadKubeObject.spec status # \u2022 Optional status : Object Type declaration # Name Type conditions { lastProbeTime : number ; lastTransitionTime : string ; status : string ; type : string }[] containerStatuses? IPodContainerStatus [] hostIP string initContainerStatuses? IPodContainerStatus [] phase string podIP string podIPs? { ip : string }[] qosClass? string reason? string startTime string Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/api/v1/pods\" kind # \u25aa Static kind : string = \"Pod\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Overrides # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAllContainers # \u25b8 getAllContainers (): IPodContainer [] Returns # IPodContainer [] getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getConditions # \u25b8 getConditions (): { lastProbeTime : number ; lastTransitionTime : string ; status : string ; type : string }[] Returns # { lastProbeTime : number ; lastTransitionTime : string ; status : string ; type : string }[] getContainerStatuses # \u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus [] Parameters # Name Type Default value includeInitContainers boolean true Returns # IPodContainerStatus [] getContainers # \u25b8 getContainers (): IPodContainer [] Returns # IPodContainer [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getIPs # \u25b8 getIPs (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getInitContainers # \u25b8 getInitContainers (): IPodContainer [] Returns # IPodContainer [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getLivenessProbe # \u25b8 getLivenessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeName # \u25b8 getNodeName (): string Returns # string getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Overrides # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getPriorityClassName # \u25b8 getPriorityClassName (): string Returns # string getProbe # \u25b8 getProbe ( probeData ): string [] Parameters # Name Type probeData IContainerProbe Returns # string [] getQosClass # \u25b8 getQosClass (): string Returns # string getReadinessProbe # \u25b8 getReadinessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getReason # \u25b8 getReason (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getRestartsCount # \u25b8 getRestartsCount (): number Returns # number getRunningContainers # \u25b8 getRunningContainers (): IPodContainer [] Returns # IPodContainer [] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSecrets # \u25b8 getSecrets (): string [] Returns # string [] getSelectedNodeOs # \u25b8 getSelectedNodeOs (): string Returns # string getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getStartupProbe # \u25b8 getStartupProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getStatus # \u25b8 getStatus (): PodStatus Returns # PodStatus getStatusMessage # \u25b8 getStatusMessage (): string Returns # string getStatusPhase # \u25b8 getStatusPhase (): string Returns # string getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): { effect? : string ; key? : string ; operator? : string ; tolerationSeconds? : number ; value? : string }[] Returns # { effect? : string ; key? : string ; operator? : string ; tolerationSeconds? : number ; value? : string }[] Overrides # WorkloadKubeObject.getTolerations getVolumes # \u25b8 getVolumes (): { configMap : { name : string } ; emptyDir : { medium? : string ; sizeLimit? : string } ; name : string ; persistentVolumeClaim : { claimName : string } ; secret : { defaultMode : number ; secretName : string } }[] Returns # { configMap : { name : string } ; emptyDir : { medium? : string ; sizeLimit? : string } ; name : string ; persistentVolumeClaim : { claimName : string } ; secret : { defaultMode : number ; secretName : string } }[] hasIssues # \u25b8 hasIssues (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Pod > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: Pod"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#class-pod","text":"Renderer . K8sApi .Pod","title":"Class: Pod"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#hierarchy","text":"WorkloadKubeObject \u21b3 Pod","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#methods","text":"delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getProbe getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getSearchFields getSecrets getSelectedNodeOs getSelectors getStartupProbe getStatus getStatusMessage getStatusPhase getTemplateLabels getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#constructor","text":"\u2022 new Pod ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#spec","text":"\u2022 Optional spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#status","text":"\u2022 Optional status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/pods\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#kind_1","text":"\u25aa Static kind : string = \"Pod\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getallcontainers","text":"\u25b8 getAllContainers (): IPodContainer []","title":"getAllContainers"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getconditions","text":"\u25b8 getConditions (): { lastProbeTime : number ; lastTransitionTime : string ; status : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getcontainerstatuses","text":"\u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus []","title":"getContainerStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getcontainers","text":"\u25b8 getContainers (): IPodContainer []","title":"getContainers"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getips","text":"\u25b8 getIPs (): string []","title":"getIPs"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getinitcontainers","text":"\u25b8 getInitContainers (): IPodContainer []","title":"getInitContainers"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getlivenessprobe","text":"\u25b8 getLivenessProbe ( container ): string []","title":"getLivenessProbe"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getnodename","text":"\u25b8 getNodeName (): string","title":"getNodeName"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getpriorityclassname","text":"\u25b8 getPriorityClassName (): string","title":"getPriorityClassName"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getprobe","text":"\u25b8 getProbe ( probeData ): string []","title":"getProbe"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getqosclass","text":"\u25b8 getQosClass (): string","title":"getQosClass"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getreadinessprobe","text":"\u25b8 getReadinessProbe ( container ): string []","title":"getReadinessProbe"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getreason","text":"\u25b8 getReason (): string","title":"getReason"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getrestartscount","text":"\u25b8 getRestartsCount (): number","title":"getRestartsCount"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getrunningcontainers","text":"\u25b8 getRunningContainers (): IPodContainer []","title":"getRunningContainers"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getsecrets","text":"\u25b8 getSecrets (): string []","title":"getSecrets"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getselectednodeos","text":"\u25b8 getSelectedNodeOs (): string","title":"getSelectedNodeOs"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getstartupprobe","text":"\u25b8 getStartupProbe ( container ): string []","title":"getStartupProbe"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getstatus","text":"\u25b8 getStatus (): PodStatus","title":"getStatus"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getstatusmessage","text":"\u25b8 getStatusMessage (): string","title":"getStatusMessage"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getstatusphase","text":"\u25b8 getStatusPhase (): string","title":"getStatusPhase"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#gettolerations","text":"\u25b8 getTolerations (): { effect? : string ; key? : string ; operator? : string ; tolerationSeconds? : number ; value? : string }[]","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#getvolumes","text":"\u25b8 getVolumes (): { configMap : { name : string } ; emptyDir : { medium? : string ; sizeLimit? : string } ; name : string ; persistentVolumeClaim : { claimName : string } ; secret : { defaultMode : number ; secretName : string } }[]","title":"getVolumes"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#hasissues","text":"\u25b8 hasIssues (): boolean","title":"hasIssues"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.pod/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/","text":"Class: PodDisruptionBudget # Renderer . K8sApi .PodDisruptionBudget Hierarchy # KubeObject \u21b3 PodDisruptionBudget Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PodDisruptionBudget ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type maxUnavailable string minAvailable string selector Object selector.matchLabels Object Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type currentHealthy number desiredHealthy number disruptionsAllowed number expectedPods number Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/policy/v1beta1/poddisruptionbudgets\" kind # \u25aa Static kind : string = \"PodDisruptionBudget\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getCurrentHealthy # \u25b8 getCurrentHealthy (): number Returns # number getDesiredHealthy # \u25b8 getDesiredHealthy (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxUnavailable # \u25b8 getMaxUnavailable (): string Returns # string getMinAvailable # \u25b8 getMinAvailable (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < PodDisruptionBudget > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#class-poddisruptionbudget","text":"Renderer . K8sApi .PodDisruptionBudget","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#hierarchy","text":"KubeObject \u21b3 PodDisruptionBudget","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#methods","text":"delete getAge getAnnotations getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#constructor","text":"\u2022 new PodDisruptionBudget ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#apibase","text":"\u25aa Static apiBase : string = \"/apis/policy/v1beta1/poddisruptionbudgets\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#kind_1","text":"\u25aa Static kind : string = \"PodDisruptionBudget\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getcurrenthealthy","text":"\u25b8 getCurrentHealthy (): number","title":"getCurrentHealthy"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getdesiredhealthy","text":"\u25b8 getDesiredHealthy (): number","title":"getDesiredHealthy"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getmaxunavailable","text":"\u25b8 getMaxUnavailable (): string","title":"getMaxUnavailable"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getminavailable","text":"\u25b8 getMinAvailable (): string","title":"getMinAvailable"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudget/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/","text":"Class: PodDisruptionBudgetsStore # Renderer . K8sApi .PodDisruptionBudgetsStore Hierarchy # KubeObjectStore < PodDisruptionBudget > \u21b3 PodDisruptionBudgetsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodDisruptionBudgetsStore ( api? ) Parameters # Name Type api? KubeApi < PodDisruptionBudget > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < PodDisruptionBudget > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < PodDisruptionBudget > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < PodDisruptionBudget , void, undefined> Returns # Generator < PodDisruptionBudget , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget [] Parameters # Name Type items PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): PodDisruptionBudget Parameters # Name Type id string Returns # PodDisruptionBudget Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): PodDisruptionBudget [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): PodDisruptionBudget Parameters # Name Type name string namespace? string Returns # PodDisruptionBudget Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): PodDisruptionBudget Parameters # Name Type path string Returns # PodDisruptionBudget Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items PodDisruptionBudget [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PodDisruptionBudget Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems PodDisruptionBudget [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget > Parameters # Name Type resourcePath string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < PodDisruptionBudget []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PodDisruptionBudget [] Parameters # Name Type partialItems PodDisruptionBudget [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget patch Patch Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item PodDisruptionBudget Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item PodDisruptionBudget request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): PodDisruptionBudget [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items PodDisruptionBudget [] the items to be sorted (default: the current items in this store) sorting ( item : PodDisruptionBudget ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems PodDisruptionBudget [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget data Partial < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget request () => Promise < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore . updateItem","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#class-poddisruptionbudgetsstore","text":"Renderer . K8sApi .PodDisruptionBudgetsStore","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#hierarchy","text":"KubeObjectStore < PodDisruptionBudget > \u21b3 PodDisruptionBudgetsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#constructor","text":"\u2022 new PodDisruptionBudgetsStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#api","text":"\u2022 api : KubeApi < PodDisruptionBudget >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#items","text":"\u2022 items : IObservableArray < PodDisruptionBudget >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#iterator","text":"\u25b8 [iterator] (): Generator < PodDisruptionBudget , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#create","text":"\u25b8 create ( params , data? ): Promise < PodDisruptionBudget >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < PodDisruptionBudget >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getbyid","text":"\u25b8 getById ( id ): PodDisruptionBudget","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PodDisruptionBudget []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): PodDisruptionBudget","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getbypath","text":"\u25b8 getByPath ( path ): PodDisruptionBudget","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getitems","text":"\u25b8 getItems (): PodDisruptionBudget []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#load","text":"\u25b8 load ( params ): Promise < PodDisruptionBudget >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < PodDisruptionBudget >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < PodDisruptionBudget []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PodDisruptionBudget []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PodDisruptionBudget >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): PodDisruptionBudget [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#update","text":"\u25b8 update ( item , data ): Promise < PodDisruptionBudget >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/","text":"Class: PodsApi # Renderer . K8sApi .PodsApi Hierarchy # KubeApi < Pod > \u21b3 PodsApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getLogs getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new PodsApi ( options ) Parameters # Name Type options IKubeApiOptions < Pod > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Pod > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Pod > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise Returns # Promise Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Pod > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Pod > Returns # Promise < Pod > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise Parameters # Name Type __namedParameters Object Returns # Promise Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Pod > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? IKubeApiQueryParams Returns # Promise < Pod > Inherited from # KubeApi . get getLogs # \u25b8 getLogs ( params , query? ): Promise Parameters # Name Type params Object params.name string params.namespace string query? IPodLogsQuery Returns # Promise getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace query? Partial Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Pod []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Pod []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial Parameters # Name Type query Partial Returns # Partial Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Pod | Pod [] Parameters # Name Type data unknown namespace? string Returns # Pod | Pod [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Pod []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Pod []> Inherited from # KubeApi . refreshResourceVersion setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Pod > Parameters # Name Type __namedParameters Object __namedParameters.name __namedParameters.namespace data? Partial < Pod > Returns # Promise < Pod > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: PodsApi"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#class-podsapi","text":"Renderer . K8sApi .PodsApi","title":"Class: PodsApi"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#hierarchy","text":"KubeApi < Pod > \u21b3 PodsApi","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#methods","text":"checkPreferredVersion create delete get getLogs getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#constructor","text":"\u2022 new PodsApi ( options )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Pod >","title":"objectConstructor"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#options","text":"\u2022 Protected options : IKubeApiOptions < Pod >","title":"options"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#resourceversions","text":"\u2022 Protected resourceVersions : Map ","title":"resourceVersions"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise ","title":"checkPreferredVersion"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Pod >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Pod >","title":"get"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#getlogs","text":"\u25b8 getLogs ( params , query? ): Promise ","title":"getLogs"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Pod []>","title":"list"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial ","title":"normalizeQuery"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Pod | Pod []","title":"parseResponse"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Pod []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Pod >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.podsapi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/","text":"Class: PodsStore # Renderer . K8sApi .PodsStore Hierarchy # KubeObjectStore < Pod > \u21b3 PodsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodsStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : PodsApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Pod > Inherited from # KubeObjectStore . items kubeMetrics # \u2022 kubeMetrics : IObservableArray limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Pod , void, undefined> Returns # Generator < Pod , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Pod [] Parameters # Name Type items Pod [] Returns # Pod [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Pod [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Pod [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Pod Parameters # Name Type id string Returns # Pod Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Pod [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Pod [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Pod Parameters # Name Type name string namespace? string Returns # Pod Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Pod Parameters # Name Type path string Returns # Pod Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Pod [] Returns # Pod [] Inherited from # KubeObjectStore . getItems getPodKubeMetrics # \u25b8 getPodKubeMetrics ( pod ): Object Parameters # Name Type pod Pod Returns # Object Name Type cpu number memory number getPodsByNode # \u25b8 getPodsByNode ( node ): Pod [] Parameters # Name Type node string Returns # Pod [] getPodsByOwner # \u25b8 getPodsByOwner ( workload ): Pod [] Parameters # Name Type workload WorkloadKubeObject Returns # Pod [] getPodsByOwnerId # \u25b8 getPodsByOwnerId ( workloadId ): Pod [] Parameters # Name Type workloadId string Returns # Pod [] getStatuses # \u25b8 getStatuses ( pods ): Dictionary Parameters # Name Type pods Pod [] Returns # Dictionary Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Pod Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Pod [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Pod > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Pod > Parameters # Name Type resourcePath string Returns # Promise < Pod > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Pod > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Pod []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Pod > Returns # Promise < Pod []> Inherited from # KubeObjectStore . loadItems loadKubeMetrics # \u25b8 loadKubeMetrics ( namespace? ): Promise Parameters # Name Type namespace? string Returns # Promise mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Pod [] Parameters # Name Type partialItems Pod [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Pod [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Pod > Parameters # Name Type item Pod patch Patch Returns # Promise < Pod > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Pod Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Pod request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Pod [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Pod [] the items to be sorted (default: the current items in this store) sorting ( item : Pod ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Pod [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Pod [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Pod > Parameters # Name Type item Pod data Partial < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Pod > Parameters # Name Type item Pod request () => Promise < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore . updateItem","title":"Class: PodsStore"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#class-podsstore","text":"Renderer . K8sApi .PodsStore","title":"Class: PodsStore"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#hierarchy","text":"KubeObjectStore < Pod > \u21b3 PodsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#constructor","text":"\u2022 new PodsStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#api","text":"\u2022 api : PodsApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#items","text":"\u2022 items : IObservableArray < Pod >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#kubemetrics","text":"\u2022 kubeMetrics : IObservableArray ","title":"kubeMetrics"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#iterator","text":"\u25b8 [iterator] (): Generator < Pod , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#create","text":"\u25b8 create ( params , data? ): Promise < Pod >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Pod >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Pod []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Pod []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getbyid","text":"\u25b8 getById ( id ): Pod","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Pod []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Pod","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getbypath","text":"\u25b8 getByPath ( path ): Pod","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getitems","text":"\u25b8 getItems (): Pod []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getpodkubemetrics","text":"\u25b8 getPodKubeMetrics ( pod ): Object","title":"getPodKubeMetrics"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getpodsbynode","text":"\u25b8 getPodsByNode ( node ): Pod []","title":"getPodsByNode"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getpodsbyowner","text":"\u25b8 getPodsByOwner ( workload ): Pod []","title":"getPodsByOwner"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getpodsbyownerid","text":"\u25b8 getPodsByOwnerId ( workloadId ): Pod []","title":"getPodsByOwnerId"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#getstatuses","text":"\u25b8 getStatuses ( pods ): Dictionary ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#load","text":"\u25b8 load ( params ): Promise < Pod >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Pod >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Pod >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Pod []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#loadkubemetrics","text":"\u25b8 loadKubeMetrics ( namespace? ): Promise ","title":"loadKubeMetrics"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Pod []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Pod >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Pod [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#update","text":"\u25b8 update ( item , data ): Promise < Pod >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.podsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Pod >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/","text":"Class: ReplicaSet # Renderer . K8sApi .ReplicaSet Hierarchy # WorkloadKubeObject \u21b3 ReplicaSet Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ReplicaSet ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type minReadySeconds? number replicas? number selector Object selector.matchLabels Object template? Object template.metadata Object template.metadata.labels Object template.metadata.labels.app string template.spec? Object template.spec.activeDeadlineSeconds? number template.spec.affinity? IAffinity template.spec.automountServiceAccountToken? boolean template.spec.containers IPodContainer [] template.spec.dnsPolicy? string template.spec.hostAliases? Object template.spec.hostAliases.hostnames string [] template.spec.hostAliases.ip string template.spec.hostIPC? boolean template.spec.hostNetwork? boolean template.spec.hostPID? boolean template.spec.hostname? string template.spec.imagePullSecrets? { name : string }[] template.spec.initContainers IPodContainer [] template.spec.nodeName? string template.spec.nodeSelector? Object template.spec.priority? number template.spec.priorityClassName? string template.spec.restartPolicy? string template.spec.schedulerName? string template.spec.securityContext? Object template.spec.serviceAccount string template.spec.serviceAccountName string template.spec.shareProcessNamespace? boolean template.spec.subdomain? string template.spec.terminationGracePeriodSeconds? number template.spec.tolerations? { effect? : string ; key? : string ; operator? : string ; tolerationSeconds? : number ; value? : string }[] template.spec.volumes? { configMap : { name : string } ; emptyDir : { medium? : string ; sizeLimit? : string } ; name : string ; persistentVolumeClaim : { claimName : string } ; secret : { defaultMode : number ; secretName : string } }[] Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type availableReplicas? number conditions? { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] fullyLabeledReplicas? number observedGeneration? number readyReplicas? number replicas number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/replicasets\" kind # \u25aa Static kind : string = \"ReplicaSet\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getCurrent # \u25b8 getCurrent (): number Returns # number getDesired # \u25b8 getDesired (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getReady # \u25b8 getReady (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ReplicaSet > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#class-replicaset","text":"Renderer . K8sApi .ReplicaSet","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#hierarchy","text":"WorkloadKubeObject \u21b3 ReplicaSet","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#constructor","text":"\u2022 new ReplicaSet ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/replicasets\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#kind_1","text":"\u25aa Static kind : string = \"ReplicaSet\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getcurrent","text":"\u25b8 getCurrent (): number","title":"getCurrent"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getdesired","text":"\u25b8 getDesired (): number","title":"getDesired"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getready","text":"\u25b8 getReady (): number","title":"getReady"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.replicaset/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/","text":"Class: ReplicaSetStore # Renderer . K8sApi .ReplicaSetStore Hierarchy # KubeObjectStore < ReplicaSet > \u21b3 ReplicaSetStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ReplicaSetStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : ReplicaSetApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < ReplicaSet > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < ReplicaSet , void, undefined> Returns # Generator < ReplicaSet , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet [] Parameters # Name Type items ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ReplicaSet [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # ReplicaSet [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): ReplicaSet Parameters # Name Type id string Returns # ReplicaSet Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ReplicaSet [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # ReplicaSet [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): ReplicaSet Parameters # Name Type name string namespace? string Returns # ReplicaSet Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): ReplicaSet Parameters # Name Type path string Returns # ReplicaSet Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( replicaSet ): Pod [] Parameters # Name Type replicaSet ReplicaSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore . getItems getReplicaSetsByOwner # \u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet [] Parameters # Name Type deployment Deployment Returns # ReplicaSet [] getStatuses # \u25b8 getStatuses ( replicaSets ): Object Parameters # Name Type replicaSets ReplicaSet [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ReplicaSet Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems ReplicaSet [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet > Parameters # Name Type resourcePath string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ReplicaSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < ReplicaSet > Returns # Promise < ReplicaSet []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ReplicaSet [] Parameters # Name Type partialItems ReplicaSet [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # ReplicaSet [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet patch Patch Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item ReplicaSet Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item ReplicaSet request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): ReplicaSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items ReplicaSet [] the items to be sorted (default: the current items in this store) sorting ( item : ReplicaSet ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ReplicaSet [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems ReplicaSet [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet data Partial < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet request () => Promise < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore . updateItem","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#class-replicasetstore","text":"Renderer . K8sApi .ReplicaSetStore","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#hierarchy","text":"KubeObjectStore < ReplicaSet > \u21b3 ReplicaSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#constructor","text":"\u2022 new ReplicaSetStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#api","text":"\u2022 api : ReplicaSetApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#items","text":"\u2022 items : IObservableArray < ReplicaSet >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#iterator","text":"\u25b8 [iterator] (): Generator < ReplicaSet , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#create","text":"\u25b8 create ( params , data? ): Promise < ReplicaSet >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < ReplicaSet >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ReplicaSet []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getbyid","text":"\u25b8 getById ( id ): ReplicaSet","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ReplicaSet []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): ReplicaSet","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getbypath","text":"\u25b8 getByPath ( path ): ReplicaSet","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getchildpods","text":"\u25b8 getChildPods ( replicaSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getitems","text":"\u25b8 getItems (): ReplicaSet []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getreplicasetsbyowner","text":"\u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet []","title":"getReplicaSetsByOwner"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#getstatuses","text":"\u25b8 getStatuses ( replicaSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#load","text":"\u25b8 load ( params ): Promise < ReplicaSet >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < ReplicaSet >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < ReplicaSet []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ReplicaSet []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ReplicaSet >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): ReplicaSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#update","text":"\u25b8 update ( item , data ): Promise < ReplicaSet >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.replicasetstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/","text":"Class: ResourceQuota # Renderer . K8sApi .ResourceQuota Hierarchy # KubeObject \u21b3 ResourceQuota Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ResourceQuota ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type hard IResourceQuotaValues scopeSelector? Object scopeSelector.matchExpressions { operator : string ; scopeName : string ; values : string [] }[] Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type hard IResourceQuotaValues used IResourceQuotaValues Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/resourcequotas\" kind # \u25aa Static kind : string = \"ResourceQuota\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopeSelector # \u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[] Returns # { operator : string ; scopeName : string ; values : string [] }[] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ResourceQuota > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#class-resourcequota","text":"Renderer . K8sApi .ResourceQuota","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#hierarchy","text":"KubeObject \u21b3 ResourceQuota","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#constructor","text":"\u2022 new ResourceQuota ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/resourcequotas\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#kind_1","text":"\u25aa Static kind : string = \"ResourceQuota\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getscopeselector","text":"\u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[]","title":"getScopeSelector"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequota/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/","text":"Class: ResourceQuotasStore # Renderer . K8sApi .ResourceQuotasStore Hierarchy # KubeObjectStore < ResourceQuota > \u21b3 ResourceQuotasStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ResourceQuotasStore ( api? ) Parameters # Name Type api? KubeApi < ResourceQuota > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < ResourceQuota > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < ResourceQuota > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < ResourceQuota , void, undefined> Returns # Generator < ResourceQuota , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota [] Parameters # Name Type items ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ResourceQuota [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # ResourceQuota [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): ResourceQuota Parameters # Name Type id string Returns # ResourceQuota Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ResourceQuota [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # ResourceQuota [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): ResourceQuota Parameters # Name Type name string namespace? string Returns # ResourceQuota Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): ResourceQuota Parameters # Name Type path string Returns # ResourceQuota Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items ResourceQuota [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ResourceQuota Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems ResourceQuota [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota > Parameters # Name Type resourcePath string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ResourceQuota []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < ResourceQuota > Returns # Promise < ResourceQuota []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ResourceQuota [] Parameters # Name Type partialItems ResourceQuota [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # ResourceQuota [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota patch Patch Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item ResourceQuota Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item ResourceQuota request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): ResourceQuota [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items ResourceQuota [] the items to be sorted (default: the current items in this store) sorting ( item : ResourceQuota ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ResourceQuota [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems ResourceQuota [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota data Partial < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota request () => Promise < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore . updateItem","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#class-resourcequotasstore","text":"Renderer . K8sApi .ResourceQuotasStore","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#hierarchy","text":"KubeObjectStore < ResourceQuota > \u21b3 ResourceQuotasStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#constructor","text":"\u2022 new ResourceQuotasStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#api","text":"\u2022 api : KubeApi < ResourceQuota >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#items","text":"\u2022 items : IObservableArray < ResourceQuota >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#iterator","text":"\u25b8 [iterator] (): Generator < ResourceQuota , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#create","text":"\u25b8 create ( params , data? ): Promise < ResourceQuota >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < ResourceQuota >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ResourceQuota []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getbyid","text":"\u25b8 getById ( id ): ResourceQuota","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ResourceQuota []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): ResourceQuota","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getbypath","text":"\u25b8 getByPath ( path ): ResourceQuota","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getitems","text":"\u25b8 getItems (): ResourceQuota []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#load","text":"\u25b8 load ( params ): Promise < ResourceQuota >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < ResourceQuota >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < ResourceQuota []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ResourceQuota []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ResourceQuota >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): ResourceQuota [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#update","text":"\u25b8 update ( item , data ): Promise < ResourceQuota >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.resourcequotasstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/","text":"Class: ResourceStack # Renderer . K8sApi .ResourceStack Table of contents # Constructors # constructor Properties # cluster name Methods # appendKubectlArgs applyResources deleteResources kubectlApplyFolder kubectlDeleteFolder renderTemplates Constructors # constructor # \u2022 new ResourceStack ( cluster , name ) Parameters # Name Type cluster KubernetesCluster name string Properties # cluster # \u2022 Protected cluster : KubernetesCluster name # \u2022 Protected name : string Methods # appendKubectlArgs # \u25b8 Protected appendKubectlArgs ( kubectlArgs ): string [] Parameters # Name Type kubectlArgs string [] Returns # string [] applyResources # \u25b8 Protected applyResources ( resources , extraArgs? ): Promise Parameters # Name Type resources string [] extraArgs? string [] Returns # Promise deleteResources # \u25b8 Protected deleteResources ( resources , extraArgs? ): Promise Parameters # Name Type resources string [] extraArgs? string [] Returns # Promise kubectlApplyFolder # \u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise Parameters # Name Type Description folderPath string folder path that is searched for files defining kubernetes resources. templateContext? any sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied. extraArgs? string [] - Returns # Promise kubectlDeleteFolder # \u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise Parameters # Name Type Description folderPath string folder path that is searched for files defining kubernetes resources. templateContext? any sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied. extraArgs? string [] - Returns # Promise renderTemplates # \u25b8 Protected renderTemplates ( folderPath , templateContext ): Promise Parameters # Name Type folderPath string templateContext any Returns # Promise ","title":"Class: ResourceStack"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#class-resourcestack","text":"Renderer . K8sApi .ResourceStack","title":"Class: ResourceStack"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#properties","text":"cluster name","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#methods","text":"appendKubectlArgs applyResources deleteResources kubectlApplyFolder kubectlDeleteFolder renderTemplates","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#constructor","text":"\u2022 new ResourceStack ( cluster , name )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#cluster","text":"\u2022 Protected cluster : KubernetesCluster","title":"cluster"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#name","text":"\u2022 Protected name : string","title":"name"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#appendkubectlargs","text":"\u25b8 Protected appendKubectlArgs ( kubectlArgs ): string []","title":"appendKubectlArgs"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#applyresources","text":"\u25b8 Protected applyResources ( resources , extraArgs? ): Promise ","title":"applyResources"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#deleteresources","text":"\u25b8 Protected deleteResources ( resources , extraArgs? ): Promise ","title":"deleteResources"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#kubectlapplyfolder","text":"\u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise ","title":"kubectlApplyFolder"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#kubectldeletefolder","text":"\u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise ","title":"kubectlDeleteFolder"},{"location":"extensions/api/classes/renderer.k8sapi.resourcestack/#rendertemplates","text":"\u25b8 Protected renderTemplates ( folderPath , templateContext ): Promise ","title":"renderTemplates"},{"location":"extensions/api/classes/renderer.k8sapi.role/","text":"Class: Role # Renderer . K8sApi .Role Hierarchy # KubeObject \u21b3 Role Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Role ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata rules # \u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/roles\" kind # \u25aa Static kind : string = \"Role\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] Returns # { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Role > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Role"},{"location":"extensions/api/classes/renderer.k8sapi.role/#class-role","text":"Renderer . K8sApi .Role","title":"Class: Role"},{"location":"extensions/api/classes/renderer.k8sapi.role/#hierarchy","text":"KubeObject \u21b3 Role","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.role/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.role/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.role/#properties","text":"apiVersion kind managedFields metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.role/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.role/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.role/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.role/#constructor","text":"\u2022 new Role ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.role/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.role/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.role/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.role/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.role/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.role/#rules","text":"\u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"rules"},{"location":"extensions/api/classes/renderer.k8sapi.role/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.role/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.role/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/roles\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.role/#kind_1","text":"\u25aa Static kind : string = \"Role\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.role/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.role/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.role/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.role/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.role/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getrules","text":"\u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"getRules"},{"location":"extensions/api/classes/renderer.k8sapi.role/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.role/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.role/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.role/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.role/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.role/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.role/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.role/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.role/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.role/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.role/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.role/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.role/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.role/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/","text":"Class: RoleBinding # Renderer . K8sApi .RoleBinding Hierarchy # KubeObject \u21b3 RoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new RoleBinding ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : Object Type declaration # Name Type apiGroup? string kind string name string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status subjects # \u2022 Optional subjects : RoleBindingSubject [] apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/rolebindings\" kind # \u25aa Static kind : string = \"RoleBinding\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): RoleBindingSubject [] Returns # RoleBindingSubject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < RoleBinding > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: RoleBinding"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#class-rolebinding","text":"Renderer . K8sApi .RoleBinding","title":"Class: RoleBinding"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#hierarchy","text":"KubeObject \u21b3 RoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#properties","text":"apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#constructor","text":"\u2022 new RoleBinding ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#roleref","text":"\u2022 roleRef : Object","title":"roleRef"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#subjects","text":"\u2022 Optional subjects : RoleBindingSubject []","title":"subjects"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#kind_1","text":"\u25aa Static kind : string = \"RoleBinding\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#getsubjects","text":"\u25b8 getSubjects (): RoleBindingSubject []","title":"getSubjects"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.rolebinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/","text":"Class: RoleBindingsStore # Renderer . K8sApi .RoleBindingsStore Hierarchy # KubeObjectStore < RoleBinding > \u21b3 RoleBindingsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects Constructors # constructor # \u2022 new RoleBindingsStore ( api? ) Parameters # Name Type api? KubeApi < RoleBinding > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < RoleBinding > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < RoleBinding > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < RoleBinding , void, undefined> Returns # Generator < RoleBinding , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace string data? Partial < RoleBinding > Returns # Promise < RoleBinding > Overrides # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): RoleBinding [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # RoleBinding [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): RoleBinding Parameters # Name Type id string Returns # RoleBinding Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): RoleBinding [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # RoleBinding [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): RoleBinding Parameters # Name Type name string namespace? string Returns # RoleBinding Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): RoleBinding Parameters # Name Type path string Returns # RoleBinding Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items RoleBinding [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item RoleBinding Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems RoleBinding [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding > Parameters # Name Type resourcePath string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < RoleBinding []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < RoleBinding > Returns # Promise < RoleBinding []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): RoleBinding [] Parameters # Name Type partialItems RoleBinding [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # RoleBinding [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < RoleBinding > Parameters # Name Type item RoleBinding patch Patch Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item RoleBinding Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item RoleBinding request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems removeSubjects # \u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjectsToRemove Iterable Returns # Promise < RoleBinding > reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): RoleBinding [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems RoleBinding [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < RoleBinding > Parameters # Name Type item RoleBinding data Partial < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < RoleBinding > Parameters # Name Type item RoleBinding request () => Promise < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore . updateItem updateSubjects # \u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjects RoleBindingSubject [] Returns # Promise < RoleBinding >","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#class-rolebindingsstore","text":"Renderer . K8sApi .RoleBindingsStore","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#hierarchy","text":"KubeObjectStore < RoleBinding > \u21b3 RoleBindingsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#constructor","text":"\u2022 new RoleBindingsStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#api","text":"\u2022 api : KubeApi < RoleBinding >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#items","text":"\u2022 items : IObservableArray < RoleBinding >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#iterator","text":"\u25b8 [iterator] (): Generator < RoleBinding , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#create","text":"\u25b8 create ( params , data? ): Promise < RoleBinding >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < RoleBinding >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): RoleBinding []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): RoleBinding []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getbyid","text":"\u25b8 getById ( id ): RoleBinding","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): RoleBinding []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): RoleBinding","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getbypath","text":"\u25b8 getByPath ( path ): RoleBinding","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getitems","text":"\u25b8 getItems (): RoleBinding []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#load","text":"\u25b8 load ( params ): Promise < RoleBinding >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < RoleBinding >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < RoleBinding []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): RoleBinding []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < RoleBinding >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#removesubjects","text":"\u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding >","title":"removeSubjects"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#sortitems","text":"\u25b8 Protected sortItems ( items ): RoleBinding [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#update","text":"\u25b8 update ( item , data ): Promise < RoleBinding >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < RoleBinding >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolebindingsstore/#updatesubjects","text":"\u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding >","title":"updateSubjects"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/","text":"Class: RolesStore # Renderer . K8sApi .RolesStore Hierarchy # KubeObjectStore < Role > \u21b3 RolesStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new RolesStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < Role > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Role > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Role , void, undefined> Returns # Generator < Role , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Role > Returns # Promise < Role > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Role > Returns # Promise < Role > Overrides # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Role [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Role [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Role Parameters # Name Type id string Returns # Role Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Role [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Role [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Role Parameters # Name Type name string namespace? string Returns # Role Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Role Parameters # Name Type path string Returns # Role Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Role [] Returns # Role [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Role [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Role Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Role [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Role > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Role > Parameters # Name Type resourcePath string Returns # Promise < Role > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Role > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Role []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Role > Returns # Promise < Role []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Role [] Parameters # Name Type partialItems Role [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Role [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Role > Parameters # Name Type item Role patch Patch Returns # Promise < Role > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Role Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Role request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): Role [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items Role [] Returns # Role [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Role [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Role > Parameters # Name Type item Role data Partial < Role > Returns # Promise < Role > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Role > Parameters # Name Type item Role request () => Promise < Role > Returns # Promise < Role > Inherited from # KubeObjectStore . updateItem","title":"Class: RolesStore"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#class-rolesstore","text":"Renderer . K8sApi .RolesStore","title":"Class: RolesStore"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#hierarchy","text":"KubeObjectStore < Role > \u21b3 RolesStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#constructor","text":"\u2022 new RolesStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#api","text":"\u2022 api : KubeApi < Role >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#items","text":"\u2022 items : IObservableArray < Role >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#iterator","text":"\u25b8 [iterator] (): Generator < Role , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#create","text":"\u25b8 create ( params , data? ): Promise < Role >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Role >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Role []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Role []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getbyid","text":"\u25b8 getById ( id ): Role","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Role []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Role","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getbypath","text":"\u25b8 getByPath ( path ): Role","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getitems","text":"\u25b8 getItems (): Role []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#load","text":"\u25b8 load ( params ): Promise < Role >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Role >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Role >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Role []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Role []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Role >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Role [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#update","text":"\u25b8 update ( item , data ): Promise < Role >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.rolesstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Role >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.secret/","text":"Class: Secret # Renderer . K8sApi .Secret Hierarchy # KubeObject \u21b3 Secret Table of contents # Constructors # constructor Properties # apiVersion data kind managedFields metadata spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Secret ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion data # \u2022 data : Object Index signature # \u25aa [prop: string ]: string Type declaration # Name Type token? string kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status type # \u2022 type : SecretType apiBase # \u25aa Static apiBase : string = \"/api/v1/secrets\" kind # \u25aa Static kind : string = \"Secret\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getToken # \u25b8 getToken (): string Returns # string patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Secret > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Secret"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#class-secret","text":"Renderer . K8sApi .Secret","title":"Class: Secret"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#hierarchy","text":"KubeObject \u21b3 Secret","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#properties","text":"apiVersion data kind managedFields metadata spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#methods","text":"delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#constructor","text":"\u2022 new Secret ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#data","text":"\u2022 data : Object","title":"data"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#type","text":"\u2022 type : SecretType","title":"type"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/secrets\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#kind_1","text":"\u25aa Static kind : string = \"Secret\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#gettoken","text":"\u25b8 getToken (): string","title":"getToken"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.secret/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/","text":"Class: SecretsStore # Renderer . K8sApi .SecretsStore Hierarchy # KubeObjectStore < Secret > \u21b3 SecretsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new SecretsStore ( api? ) Parameters # Name Type api? KubeApi < Secret > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < Secret > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Secret > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Secret , void, undefined> Returns # Generator < Secret , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Secret [] Parameters # Name Type items Secret [] Returns # Secret [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Secret [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Secret [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Secret Parameters # Name Type id string Returns # Secret Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Secret [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Secret [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Secret Parameters # Name Type name string namespace? string Returns # Secret Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Secret Parameters # Name Type path string Returns # Secret Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Secret [] Returns # Secret [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Secret [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Secret Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Secret [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Secret > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Secret > Parameters # Name Type resourcePath string Returns # Promise < Secret > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Secret > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Secret []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Secret > Returns # Promise < Secret []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Secret [] Parameters # Name Type partialItems Secret [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Secret [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Secret > Parameters # Name Type item Secret patch Patch Returns # Promise < Secret > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Secret Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Secret request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Secret [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Secret [] the items to be sorted (default: the current items in this store) sorting ( item : Secret ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Secret [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Secret [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Secret > Parameters # Name Type item Secret data Partial < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Secret > Parameters # Name Type item Secret request () => Promise < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore . updateItem","title":"Class: SecretsStore"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#class-secretsstore","text":"Renderer . K8sApi .SecretsStore","title":"Class: SecretsStore"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#hierarchy","text":"KubeObjectStore < Secret > \u21b3 SecretsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#constructor","text":"\u2022 new SecretsStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#api","text":"\u2022 api : KubeApi < Secret >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#items","text":"\u2022 items : IObservableArray < Secret >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#iterator","text":"\u25b8 [iterator] (): Generator < Secret , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#create","text":"\u25b8 create ( params , data? ): Promise < Secret >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Secret >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Secret []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Secret []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getbyid","text":"\u25b8 getById ( id ): Secret","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Secret []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Secret","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getbypath","text":"\u25b8 getByPath ( path ): Secret","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getitems","text":"\u25b8 getItems (): Secret []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#load","text":"\u25b8 load ( params ): Promise < Secret >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Secret >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Secret >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Secret []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Secret []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Secret >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Secret [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#update","text":"\u25b8 update ( item , data ): Promise < Secret >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.secretsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Secret >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.service/","text":"Class: Service # Renderer . K8sApi .Service Hierarchy # KubeObject \u21b3 Service Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getClusterIp getClusterIps getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Service ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type allocateLoadBalancerNodePorts? boolean clusterIP string clusterIPs? string [] externalIPs? string [] externalName string externalTrafficPolicy? string healthCheckNodePort? number internalTrafficPolicy? string ipFamilies? string [] ipFamilyPolicy? string loadBalancerClass? string loadBalancerIP? string loadBalancerSourceRanges? string [] ports ServicePort [] selector Object sessionAffinity string topologyKeys? string [] type string Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type loadBalancer? Object loadBalancer.ingress? { hostname? : string ; ip? : string }[] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/services\" kind # \u25aa Static kind : string = \"Service\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getClusterIp # \u25b8 getClusterIp (): string Returns # string getClusterIps # \u25b8 getClusterIps (): string [] Returns # string [] getExternalIps # \u25b8 getExternalIps (): string [] Returns # string [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getIpFamilies # \u25b8 getIpFamilies (): string [] Returns # string [] getIpFamilyPolicy # \u25b8 getIpFamilyPolicy (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancer # \u25b8 getLoadBalancer (): Object Returns # Object Name Type ingress? { hostname? : string ; ip? : string }[] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): ServicePort [] Returns # ServicePort [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelector # \u25b8 getSelector (): string [] Returns # string [] getStatus # \u25b8 getStatus (): \"Active\" | \"Pending\" Returns # \"Active\" | \"Pending\" getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getType # \u25b8 getType (): string Returns # string isActive # \u25b8 isActive (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Service > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Service"},{"location":"extensions/api/classes/renderer.k8sapi.service/#class-service","text":"Renderer . K8sApi .Service","title":"Class: Service"},{"location":"extensions/api/classes/renderer.k8sapi.service/#hierarchy","text":"KubeObject \u21b3 Service","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.service/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.service/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.service/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.service/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.service/#methods","text":"delete getAge getAnnotations getClusterIp getClusterIps getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.service/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.service/#constructor","text":"\u2022 new Service ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.service/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.service/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.service/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.service/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.service/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.service/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.service/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.service/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/services\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.service/#kind_1","text":"\u25aa Static kind : string = \"Service\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.service/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.service/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.service/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.service/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.service/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getclusterip","text":"\u25b8 getClusterIp (): string","title":"getClusterIp"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getclusterips","text":"\u25b8 getClusterIps (): string []","title":"getClusterIps"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getexternalips","text":"\u25b8 getExternalIps (): string []","title":"getExternalIps"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getipfamilies","text":"\u25b8 getIpFamilies (): string []","title":"getIpFamilies"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getipfamilypolicy","text":"\u25b8 getIpFamilyPolicy (): string","title":"getIpFamilyPolicy"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getloadbalancer","text":"\u25b8 getLoadBalancer (): Object","title":"getLoadBalancer"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getports","text":"\u25b8 getPorts (): ServicePort []","title":"getPorts"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getselector","text":"\u25b8 getSelector (): string []","title":"getSelector"},{"location":"extensions/api/classes/renderer.k8sapi.service/#getstatus","text":"\u25b8 getStatus (): \"Active\" | \"Pending\"","title":"getStatus"},{"location":"extensions/api/classes/renderer.k8sapi.service/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.service/#gettype","text":"\u25b8 getType (): string","title":"getType"},{"location":"extensions/api/classes/renderer.k8sapi.service/#isactive","text":"\u25b8 isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/renderer.k8sapi.service/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.service/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.service/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.service/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.service/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.service/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.service/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.service/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.service/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.service/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.service/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.service/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/","text":"Class: ServiceAccount # Renderer . K8sApi .ServiceAccount Hierarchy # KubeObject \u21b3 ServiceAccount Table of contents # Constructors # constructor Properties # apiVersion imagePullSecrets kind managedFields metadata secrets spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ServiceAccount ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion imagePullSecrets # \u2022 Optional imagePullSecrets : { name : string }[] kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata secrets # \u2022 Optional secrets : { name : string }[] spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/serviceaccounts\" kind # \u25aa Static kind : string = \"ServiceAccount\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImagePullSecrets # \u25b8 getImagePullSecrets (): { name : string }[] Returns # { name : string }[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSecrets # \u25b8 getSecrets (): { name : string }[] Returns # { name : string }[] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ServiceAccount > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#class-serviceaccount","text":"Renderer . K8sApi .ServiceAccount","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#hierarchy","text":"KubeObject \u21b3 ServiceAccount","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#properties","text":"apiVersion imagePullSecrets kind managedFields metadata secrets spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#methods","text":"delete getAge getAnnotations getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#constructor","text":"\u2022 new ServiceAccount ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#imagepullsecrets","text":"\u2022 Optional imagePullSecrets : { name : string }[]","title":"imagePullSecrets"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#secrets","text":"\u2022 Optional secrets : { name : string }[]","title":"secrets"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/serviceaccounts\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#kind_1","text":"\u25aa Static kind : string = \"ServiceAccount\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getimagepullsecrets","text":"\u25b8 getImagePullSecrets (): { name : string }[]","title":"getImagePullSecrets"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#getsecrets","text":"\u25b8 getSecrets (): { name : string }[]","title":"getSecrets"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccount/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/","text":"Class: ServiceAccountsStore # Renderer . K8sApi .ServiceAccountsStore Hierarchy # KubeObjectStore < ServiceAccount > \u21b3 ServiceAccountsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceAccountsStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < ServiceAccount > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < ServiceAccount > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < ServiceAccount , void, undefined> Returns # Generator < ServiceAccount , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ServiceAccount > Overrides # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount [] Parameters # Name Type items ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ServiceAccount [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # ServiceAccount [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): ServiceAccount Parameters # Name Type id string Returns # ServiceAccount Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ServiceAccount [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # ServiceAccount [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): ServiceAccount Parameters # Name Type name string namespace? string Returns # ServiceAccount Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): ServiceAccount Parameters # Name Type path string Returns # ServiceAccount Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items ServiceAccount [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ServiceAccount Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems ServiceAccount [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount > Parameters # Name Type resourcePath string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ServiceAccount []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < ServiceAccount > Returns # Promise < ServiceAccount []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ServiceAccount [] Parameters # Name Type partialItems ServiceAccount [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # ServiceAccount [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount patch Patch Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item ServiceAccount Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item ServiceAccount request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): ServiceAccount [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items ServiceAccount [] the items to be sorted (default: the current items in this store) sorting ( item : ServiceAccount ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ServiceAccount [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems ServiceAccount [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount data Partial < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount request () => Promise < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore . updateItem","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#class-serviceaccountsstore","text":"Renderer . K8sApi .ServiceAccountsStore","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#hierarchy","text":"KubeObjectStore < ServiceAccount > \u21b3 ServiceAccountsStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#constructor","text":"\u2022 new ServiceAccountsStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#api","text":"\u2022 api : KubeApi < ServiceAccount >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#items","text":"\u2022 items : IObservableArray < ServiceAccount >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#iterator","text":"\u25b8 [iterator] (): Generator < ServiceAccount , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#create","text":"\u25b8 create ( params , data? ): Promise < ServiceAccount >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#createitem","text":"\u25b8 Protected createItem ( params ): Promise < ServiceAccount >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ServiceAccount []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getbyid","text":"\u25b8 getById ( id ): ServiceAccount","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ServiceAccount []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): ServiceAccount","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getbypath","text":"\u25b8 getByPath ( path ): ServiceAccount","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getitems","text":"\u25b8 getItems (): ServiceAccount []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#load","text":"\u25b8 load ( params ): Promise < ServiceAccount >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < ServiceAccount >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < ServiceAccount []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ServiceAccount []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ServiceAccount >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): ServiceAccount [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#update","text":"\u25b8 update ( item , data ): Promise < ServiceAccount >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.serviceaccountsstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/","text":"Class: ServiceStore # Renderer . K8sApi .ServiceStore Hierarchy # KubeObjectStore < Service > \u21b3 ServiceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceStore ( api? ) Parameters # Name Type api? KubeApi < Service > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < Service > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Service > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Service , void, undefined> Returns # Generator < Service , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Service > Returns # Promise < Service > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Service > Returns # Promise < Service > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Service [] Parameters # Name Type items Service [] Returns # Service [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Service [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Service [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Service Parameters # Name Type id string Returns # Service Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Service [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Service [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Service Parameters # Name Type name string namespace? string Returns # Service Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Service Parameters # Name Type path string Returns # Service Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Service [] Returns # Service [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items Service [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Service Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Service [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Service > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Service > Parameters # Name Type resourcePath string Returns # Promise < Service > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Service > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Service []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Service > Returns # Promise < Service []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Service [] Parameters # Name Type partialItems Service [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # Service [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Service > Parameters # Name Type item Service patch Patch Returns # Promise < Service > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item Service Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item Service request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Service [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Service [] the items to be sorted (default: the current items in this store) sorting ( item : Service ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Service [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Service [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Service > Parameters # Name Type item Service data Partial < Service > Returns # Promise < Service > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Service > Parameters # Name Type item Service request () => Promise < Service > Returns # Promise < Service > Inherited from # KubeObjectStore . updateItem","title":"Class: ServiceStore"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#class-servicestore","text":"Renderer . K8sApi .ServiceStore","title":"Class: ServiceStore"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#hierarchy","text":"KubeObjectStore < Service > \u21b3 ServiceStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#constructor","text":"\u2022 new ServiceStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#api","text":"\u2022 api : KubeApi < Service >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#items","text":"\u2022 items : IObservableArray < Service >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#iterator","text":"\u25b8 [iterator] (): Generator < Service , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#create","text":"\u25b8 create ( params , data? ): Promise < Service >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Service >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Service []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Service []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getbyid","text":"\u25b8 getById ( id ): Service","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Service []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Service","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getbypath","text":"\u25b8 getByPath ( path ): Service","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getitems","text":"\u25b8 getItems (): Service []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#load","text":"\u25b8 load ( params ): Promise < Service >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Service >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Service >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Service []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Service []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Service >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Service [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#update","text":"\u25b8 update ( item , data ): Promise < Service >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.servicestore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Service >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/","text":"Class: StatefulSet # Renderer . K8sApi .StatefulSet Hierarchy # WorkloadKubeObject \u21b3 StatefulSet Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StatefulSet ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type replicas number selector Object selector.matchLabels Object serviceName string template Object template.metadata Object template.metadata.labels Object template.metadata.labels.app string template.spec Object template.spec.affinity? IAffinity template.spec.containers { image : string ; name : string ; ports : { containerPort : number ; name : string }[] ; volumeMounts : { mountPath : string ; name : string }[] }[] template.spec.nodeSelector? Object template.spec.tolerations { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] volumeClaimTemplates { metadata : { name : string } ; spec : { accessModes : string [] ; resources : { requests : { storage : string } } } }[] Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type collisionCount number currentReplicas number currentRevision string observedGeneration number readyReplicas number replicas number updateRevision string Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/statefulsets\" kind # \u25aa Static kind : string = \"StatefulSet\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < StatefulSet > Returns # Promise Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: StatefulSet"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#class-statefulset","text":"Renderer . K8sApi .StatefulSet","title":"Class: StatefulSet"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#hierarchy","text":"WorkloadKubeObject \u21b3 StatefulSet","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#constructor","text":"\u2022 new StatefulSet ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/statefulsets\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#kind_1","text":"\u25aa Static kind : string = \"StatefulSet\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.statefulset/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/","text":"Class: StatefulSetStore # Renderer . K8sApi .StatefulSetStore Hierarchy # KubeObjectStore < StatefulSet > \u21b3 StatefulSetStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StatefulSetStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : StatefulSetApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < StatefulSet > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < StatefulSet , void, undefined> Returns # Generator < StatefulSet , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StatefulSet [] Parameters # Name Type items StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StatefulSet [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # StatefulSet [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): StatefulSet Parameters # Name Type id string Returns # StatefulSet Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): StatefulSet [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # StatefulSet [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): StatefulSet Parameters # Name Type name string namespace? string Returns # StatefulSet Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): StatefulSet Parameters # Name Type path string Returns # StatefulSet Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( statefulSet ): Pod [] Parameters # Name Type statefulSet StatefulSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( statefulSets ): Object Parameters # Name Type statefulSets StatefulSet [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StatefulSet Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems StatefulSet [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet > Parameters # Name Type resourcePath string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < StatefulSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < StatefulSet > Returns # Promise < StatefulSet []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): StatefulSet [] Parameters # Name Type partialItems StatefulSet [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # StatefulSet [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < StatefulSet > Parameters # Name Type item StatefulSet patch Patch Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item StatefulSet Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item StatefulSet request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): StatefulSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items StatefulSet [] the items to be sorted (default: the current items in this store) sorting ( item : StatefulSet ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # StatefulSet [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems StatefulSet [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < StatefulSet > Parameters # Name Type item StatefulSet data Partial < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StatefulSet > Parameters # Name Type item StatefulSet request () => Promise < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore . updateItem","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#class-statefulsetstore","text":"Renderer . K8sApi .StatefulSetStore","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#hierarchy","text":"KubeObjectStore < StatefulSet > \u21b3 StatefulSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#constructor","text":"\u2022 new StatefulSetStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#api","text":"\u2022 api : StatefulSetApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#items","text":"\u2022 items : IObservableArray < StatefulSet >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#iterator","text":"\u25b8 [iterator] (): Generator < StatefulSet , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#create","text":"\u25b8 create ( params , data? ): Promise < StatefulSet >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < StatefulSet >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StatefulSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StatefulSet []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getbyid","text":"\u25b8 getById ( id ): StatefulSet","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StatefulSet []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): StatefulSet","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getbypath","text":"\u25b8 getByPath ( path ): StatefulSet","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getchildpods","text":"\u25b8 getChildPods ( statefulSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getitems","text":"\u25b8 getItems (): StatefulSet []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#getstatuses","text":"\u25b8 getStatuses ( statefulSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#load","text":"\u25b8 load ( params ): Promise < StatefulSet >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < StatefulSet >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < StatefulSet []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): StatefulSet []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StatefulSet >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): StatefulSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#update","text":"\u25b8 update ( item , data ): Promise < StatefulSet >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.statefulsetstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StatefulSet >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/","text":"Class: StorageClass # Renderer . K8sApi .StorageClass Hierarchy # KubeObject \u21b3 StorageClass Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StorageClass ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata mountOptions # \u2022 Optional mountOptions : string [] parameters # \u2022 parameters : Object Index signature # \u25aa [param: string ]: string provisioner # \u2022 provisioner : string reclaimPolicy # \u2022 reclaimPolicy : string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status volumeBindingMode # \u2022 volumeBindingMode : string apiBase # \u25aa Static apiBase : string = \"/apis/storage.k8s.io/v1/storageclasses\" kind # \u25aa Static kind : string = \"StorageClass\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise Parameters # Name Type params? JsonApiParams Returns # Promise Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReclaimPolicy # \u25b8 getReclaimPolicy (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getVolumeBindingMode # \u25b8 getVolumeBindingMode (): string Returns # string isDefault # \u25b8 isDefault (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise Parameters # Name Type patch Patch Returns # Promise Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < StorageClass > Returns # Promise Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject Parameters # Name Type data KubeJsonApiData Returns # KubeObject Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: StorageClass"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#class-storageclass","text":"Renderer . K8sApi .StorageClass","title":"Class: StorageClass"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#hierarchy","text":"KubeObject \u21b3 StorageClass","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#properties","text":"apiVersion kind managedFields metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#constructor","text":"\u2022 new StorageClass ( data )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#mountoptions","text":"\u2022 Optional mountOptions : string []","title":"mountOptions"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#parameters_1","text":"\u2022 parameters : Object","title":"parameters"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#provisioner","text":"\u2022 provisioner : string","title":"provisioner"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#reclaimpolicy","text":"\u2022 reclaimPolicy : string","title":"reclaimPolicy"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#volumebindingmode","text":"\u2022 volumeBindingMode : string","title":"volumeBindingMode"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#apibase","text":"\u25aa Static apiBase : string = \"/apis/storage.k8s.io/v1/storageclasses\"","title":"apiBase"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#kind_1","text":"\u25aa Static kind : string = \"StorageClass\"","title":"kind"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#delete","text":"\u25b8 delete ( params? ): Promise ","title":"delete"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getreclaimpolicy","text":"\u25b8 getReclaimPolicy (): string","title":"getReclaimPolicy"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#getvolumebindingmode","text":"\u25b8 getVolumeBindingMode (): string","title":"getVolumeBindingMode"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#isdefault","text":"\u25b8 isDefault (): boolean","title":"isDefault"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#patch","text":"\u25b8 patch ( patch ): Promise ","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#update","text":"\u25b8 update ( data ): Promise Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#create","text":"\u25b8 Static create ( data ): KubeObject ","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList ( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/renderer.k8sapi.storageclass/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/","text":"Class: StorageClassStore # Renderer . K8sApi .StorageClassStore Hierarchy # KubeObjectStore < StorageClass > \u21b3 StorageClassStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StorageClassStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < StorageClass > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < StorageClass > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < StorageClass , void, undefined> Returns # Generator < StorageClass , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StorageClass [] Parameters # Name Type items StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StorageClass [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # StorageClass [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): StorageClass Parameters # Name Type id string Returns # StorageClass Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): StorageClass [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # StorageClass [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): StorageClass Parameters # Name Type name string namespace? string Returns # StorageClass Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): StorageClass Parameters # Name Type path string Returns # StorageClass Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore . getItems getPersistentVolumes # \u25b8 getPersistentVolumes ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items StorageClass [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StorageClass Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems StorageClass [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StorageClass > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StorageClass > Parameters # Name Type resourcePath string Returns # Promise < StorageClass > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StorageClass > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < StorageClass []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < StorageClass > Returns # Promise < StorageClass []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): StorageClass [] Parameters # Name Type partialItems StorageClass [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # StorageClass [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < StorageClass > Parameters # Name Type item StorageClass patch Patch Returns # Promise < StorageClass > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item StorageClass Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item StorageClass request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): StorageClass [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items StorageClass [] the items to be sorted (default: the current items in this store) sorting ( item : StorageClass ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # StorageClass [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems StorageClass [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < StorageClass > Parameters # Name Type item StorageClass data Partial < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StorageClass > Parameters # Name Type item StorageClass request () => Promise < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore . updateItem","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#class-storageclassstore","text":"Renderer . K8sApi .StorageClassStore","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#hierarchy","text":"KubeObjectStore < StorageClass > \u21b3 StorageClassStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#constructor","text":"\u2022 new StorageClassStore ()","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#api","text":"\u2022 api : KubeApi < StorageClass >","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#items","text":"\u2022 items : IObservableArray < StorageClass >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#iterator","text":"\u25b8 [iterator] (): Generator < StorageClass , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#create","text":"\u25b8 create ( params , data? ): Promise < StorageClass >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < StorageClass >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StorageClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StorageClass []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getbyid","text":"\u25b8 getById ( id ): StorageClass","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StorageClass []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): StorageClass","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getbypath","text":"\u25b8 getByPath ( path ): StorageClass","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getitems","text":"\u25b8 getItems (): StorageClass []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getpersistentvolumes","text":"\u25b8 getPersistentVolumes ( storageClass ): PersistentVolume []","title":"getPersistentVolumes"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#load","text":"\u25b8 load ( params ): Promise < StorageClass >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StorageClass >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < StorageClass >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < StorageClass []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): StorageClass []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StorageClass >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): StorageClass [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#update","text":"\u25b8 update ( item , data ): Promise < StorageClass >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.storageclassstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StorageClass >","title":"updateItem"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/","text":"Class: VolumeClaimStore # Renderer . K8sApi .VolumeClaimStore Hierarchy # KubeObjectStore < PersistentVolumeClaim > \u21b3 VolumeClaimStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new VolumeClaimStore ( api? ) Parameters # Name Type api? KubeApi < PersistentVolumeClaim > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : PersistentVolumeClaimsApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray > Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < PersistentVolumeClaim > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise & { cancel : () => void } Returns # Promise & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolumeClaim , void, undefined> Returns # Generator < PersistentVolumeClaim , void, undefined> Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim [] Parameters # Name Type items PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): PersistentVolumeClaim Parameters # Name Type id string Returns # PersistentVolumeClaim Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolumeClaim [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): PersistentVolumeClaim Parameters # Name Type name string namespace? string Returns # PersistentVolumeClaim Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): PersistentVolumeClaim Parameters # Name Type path string Returns # PersistentVolumeClaim Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record Parameters # Name Type items PersistentVolumeClaim [] Returns # Record Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolumeClaim Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems PersistentVolumeClaim [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < PersistentVolumeClaim []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PersistentVolumeClaim [] Parameters # Name Type partialItems PersistentVolumeClaim [] __namedParameters Object __namedParameters.filter __namedParameters.replace __namedParameters.sort __namedParameters.updateStore Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim patch Patch Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise Parameters # Name Type item PersistentVolumeClaim Returns # Promise Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise Parameters # Name Type item PersistentVolumeClaim request () => Promise Returns # Promise Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise Returns # Promise Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): PersistentVolumeClaim [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items PersistentVolumeClaim [] the items to be sorted (default: the current items in this store) sorting ( item : PersistentVolumeClaim ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems PersistentVolumeClaim [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim data Partial < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim request () => Promise < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore . updateItem","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#class-volumeclaimstore","text":"Renderer . K8sApi .VolumeClaimStore","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#hierarchy","text":"KubeObjectStore < PersistentVolumeClaim > \u21b3 VolumeClaimStore","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#constructor","text":"\u2022 new VolumeClaimStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#api","text":"\u2022 api : PersistentVolumeClaimsApi","title":"api"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray >","title":"eventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#items","text":"\u2022 items : IObservableArray < PersistentVolumeClaim >","title":"items"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap ","title":"selectedItemsIds"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue ","title":"defaultContext"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#contextready","text":"\u2022 get contextReady (): Promise & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#namespacesready","text":"\u2022 get namespacesReady (): Promise & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolumeClaim , void, undefined>","title":"[iterator]"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolumeClaim >","title":"create"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < PersistentVolumeClaim >","title":"createItem"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim []","title":"getAllByNs"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getbyid","text":"\u25b8 getById ( id ): PersistentVolumeClaim","title":"getById"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolumeClaim []","title":"getByLabel"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): PersistentVolumeClaim","title":"getByName"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getbypath","text":"\u25b8 getByPath ( path ): PersistentVolumeClaim","title":"getByPath"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getitems","text":"\u25b8 getItems (): PersistentVolumeClaim []","title":"getItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record ","title":"getStatuses"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolumeClaim >","title":"load"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#loadall","text":"\u25b8 loadAll ( options? ): Promise ","title":"loadAll"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim >","title":"loadFromPath"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < PersistentVolumeClaim >","title":"loadItem"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < PersistentVolumeClaim []>","title":"loadItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): PersistentVolumeClaim []","title":"mergeItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim >","title":"patch"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise ","title":"reloadAll"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#remove","text":"\u25b8 remove ( item ): Promise ","title":"remove"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise ","title":"removeItem"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise ","title":"removeSelectedItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): PersistentVolumeClaim [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolumeClaim >","title":"update"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/renderer.k8sapi.volumeclaimstore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim >","title":"updateItem"},{"location":"extensions/api/classes/renderer.lensextension/","text":"Class: LensExtension # Renderer .LensExtension Hierarchy # LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # [Disposers] appPreferences catalogEntityDetailItems clusterPageMenus clusterPages commands entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus Accessors # description name version Methods # addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate Constructors # constructor # \u2022 new LensExtension ( __namedParameters ) Parameters # Name Type __namedParameters InstalledExtension Inherited from # LensExtension.constructor Properties # [Disposers] # \u2022 [Disposers] : ExtendableDisposer Inherited from # LensExtension.__@Disposers@24661 appPreferences # \u2022 appPreferences : AppPreferenceRegistration [] = [] catalogEntityDetailItems # \u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[] = [] clusterPageMenus # \u2022 clusterPageMenus : ClusterPageMenuRegistration [] = [] clusterPages # \u2022 clusterPages : PageRegistration [] = [] commands # \u2022 commands : CommandRegistration [] = [] entitySettings # \u2022 entitySettings : EntitySettingRegistration [] = [] globalPages # \u2022 globalPages : PageRegistration [] = [] id # \u2022 Readonly id : string Inherited from # LensExtension.id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension.isBundled kubeObjectDetailItems # \u2022 kubeObjectDetailItems : KubeObjectDetailRegistration [] = [] kubeObjectMenuItems # \u2022 kubeObjectMenuItems : KubeObjectMenuRegistration [] = [] kubeObjectStatusTexts # \u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration [] = [] kubeWorkloadsOverviewItems # \u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration [] = [] manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension.manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension.manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] = [] Inherited from # LensExtension.protocolHandlers statusBarItems # \u2022 statusBarItems : StatusBarRegistration [] = [] topBarItems # \u2022 topBarItems : TopBarRegistration [] = [] welcomeBanners # \u2022 welcomeBanners : WelcomeBannerRegistration [] = [] welcomeMenus # \u2022 welcomeMenus : WelcomeMenuRegistration [] = [] Accessors # description # \u2022 get description (): string Returns # string name # \u2022 get name (): string Returns # string version # \u2022 get version (): string Returns # string Methods # addCatalogFilter # \u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog. This will be removed if the extension is disabled. Parameters # Name Type Description fn EntityFilter The function which should return a truthy value for those entities which should be kepted Returns # Disposer A function to clean up the filter disable # \u25b8 disable (): Promise Returns # Promise Inherited from # LensExtension.disable enable # \u25b8 enable ( register ): Promise Parameters # Name Type register ( ext : LensExtension ) => Promise Returns # Promise Inherited from # LensExtension.enable getExtensionFileFolder # \u25b8 getExtensionFileFolder (): Promise 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 obfuscation of the folder name. Returns # Promise Inherited from # LensExtension.getExtensionFileFolder isEnabledForCluster # \u25b8 isEnabledForCluster ( cluster ): Promise Defines if extension is enabled for a given cluster. Defaults to true . Parameters # Name Type cluster Cluster Returns # Promise navigate # \u25b8 navigate

( pageId? , params? ): Promise Type parameters # Name Type P P : object Parameters # Name Type pageId? string params? P Returns # Promise onActivate # \u25b8 Protected onActivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onDeactivate","title":"Class: LensExtension"},{"location":"extensions/api/classes/renderer.lensextension/#class-lensextension","text":"Renderer .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/renderer.lensextension/#hierarchy","text":"LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.lensextension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.lensextension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.lensextension/#properties","text":"[Disposers] appPreferences catalogEntityDetailItems clusterPageMenus clusterPages commands entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus","title":"Properties"},{"location":"extensions/api/classes/renderer.lensextension/#accessors","text":"description name version","title":"Accessors"},{"location":"extensions/api/classes/renderer.lensextension/#methods","text":"addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate","title":"Methods"},{"location":"extensions/api/classes/renderer.lensextension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.lensextension/#constructor","text":"\u2022 new LensExtension ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/renderer.lensextension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.lensextension/#disposers","text":"\u2022 [Disposers] : ExtendableDisposer","title":"[Disposers]"},{"location":"extensions/api/classes/renderer.lensextension/#apppreferences","text":"\u2022 appPreferences : AppPreferenceRegistration [] = []","title":"appPreferences"},{"location":"extensions/api/classes/renderer.lensextension/#catalogentitydetailitems","text":"\u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[] = []","title":"catalogEntityDetailItems"},{"location":"extensions/api/classes/renderer.lensextension/#clusterpagemenus","text":"\u2022 clusterPageMenus : ClusterPageMenuRegistration [] = []","title":"clusterPageMenus"},{"location":"extensions/api/classes/renderer.lensextension/#clusterpages","text":"\u2022 clusterPages : PageRegistration [] = []","title":"clusterPages"},{"location":"extensions/api/classes/renderer.lensextension/#commands","text":"\u2022 commands : CommandRegistration [] = []","title":"commands"},{"location":"extensions/api/classes/renderer.lensextension/#entitysettings","text":"\u2022 entitySettings : EntitySettingRegistration [] = []","title":"entitySettings"},{"location":"extensions/api/classes/renderer.lensextension/#globalpages","text":"\u2022 globalPages : PageRegistration [] = []","title":"globalPages"},{"location":"extensions/api/classes/renderer.lensextension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/renderer.lensextension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/renderer.lensextension/#kubeobjectdetailitems","text":"\u2022 kubeObjectDetailItems : KubeObjectDetailRegistration [] = []","title":"kubeObjectDetailItems"},{"location":"extensions/api/classes/renderer.lensextension/#kubeobjectmenuitems","text":"\u2022 kubeObjectMenuItems : KubeObjectMenuRegistration [] = []","title":"kubeObjectMenuItems"},{"location":"extensions/api/classes/renderer.lensextension/#kubeobjectstatustexts","text":"\u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration [] = []","title":"kubeObjectStatusTexts"},{"location":"extensions/api/classes/renderer.lensextension/#kubeworkloadsoverviewitems","text":"\u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration [] = []","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/api/classes/renderer.lensextension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/renderer.lensextension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/renderer.lensextension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration [] = []","title":"protocolHandlers"},{"location":"extensions/api/classes/renderer.lensextension/#statusbaritems","text":"\u2022 statusBarItems : StatusBarRegistration [] = []","title":"statusBarItems"},{"location":"extensions/api/classes/renderer.lensextension/#topbaritems","text":"\u2022 topBarItems : TopBarRegistration [] = []","title":"topBarItems"},{"location":"extensions/api/classes/renderer.lensextension/#welcomebanners","text":"\u2022 welcomeBanners : WelcomeBannerRegistration [] = []","title":"welcomeBanners"},{"location":"extensions/api/classes/renderer.lensextension/#welcomemenus","text":"\u2022 welcomeMenus : WelcomeMenuRegistration [] = []","title":"welcomeMenus"},{"location":"extensions/api/classes/renderer.lensextension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.lensextension/#description","text":"\u2022 get description (): string","title":"description"},{"location":"extensions/api/classes/renderer.lensextension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/renderer.lensextension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/renderer.lensextension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.lensextension/#addcatalogfilter","text":"\u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog. This will be removed if the extension is disabled.","title":"addCatalogFilter"},{"location":"extensions/api/classes/renderer.lensextension/#disable","text":"\u25b8 disable (): Promise ","title":"disable"},{"location":"extensions/api/classes/renderer.lensextension/#enable","text":"\u25b8 enable ( register ): Promise ","title":"enable"},{"location":"extensions/api/classes/renderer.lensextension/#getextensionfilefolder","text":"\u25b8 getExtensionFileFolder (): Promise 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 obfuscation of the folder name.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/renderer.lensextension/#isenabledforcluster","text":"\u25b8 isEnabledForCluster ( cluster ): Promise Defines if extension is enabled for a given cluster. Defaults to true .","title":"isEnabledForCluster"},{"location":"extensions/api/classes/renderer.lensextension/#navigate","text":"\u25b8 navigate

( pageId? , params? ): Promise ","title":"navigate"},{"location":"extensions/api/classes/renderer.lensextension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise ","title":"onActivate"},{"location":"extensions/api/classes/renderer.lensextension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise ","title":"onDeactivate"},{"location":"extensions/api/classes/renderer.navigation.pageparam/","text":"Class: PageParam # Renderer . Navigation .PageParam Type parameters # Name Type V V = any Table of contents # Constructors # constructor Properties # isMulti name Accessors # defaultValue Methods # clear get getRaw parse set setRaw stringify toString Constructors # constructor # \u2022 new PageParam ( init , history ) Type parameters # Name Type V V = any Parameters # Name Type init PageParamInit history ObservableHistory < Object > Properties # isMulti # \u2022 Readonly isMulti : boolean name # \u2022 Readonly name : string Accessors # defaultValue # \u2022 get defaultValue (): V Returns # V Methods # clear # \u25b8 clear (): void Returns # void get # \u25b8 get (): V Returns # V getRaw # \u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search Returns # string | string [] parse # \u25b8 parse ( values ): V Parameters # Name Type values string | string [] Returns # V set # \u25b8 set ( value , __namedParameters? ): void Parameters # Name Type value V __namedParameters Object __namedParameters.mergeGlobals __namedParameters.replaceHistory Returns # void setRaw # \u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search Parameters # Name Type value string | string [] Returns # void stringify # \u25b8 stringify ( value? ): string [] Parameters # Name Type value V Returns # string [] toString # \u25b8 toString ( __namedParameters? ): string Parameters # Name Type __namedParameters Object __namedParameters.mergeGlobals __namedParameters.value __namedParameters.withPrefix Returns # string","title":"Class: PageParam"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#class-pageparamv","text":"Renderer . Navigation .PageParam","title":"Class: PageParam<V>"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#type-parameters","text":"Name Type V V = any","title":"Type parameters"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#properties","text":"isMulti name","title":"Properties"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#accessors","text":"defaultValue","title":"Accessors"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#methods","text":"clear get getRaw parse set setRaw stringify toString","title":"Methods"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#constructor","text":"\u2022 new PageParam ( init , history )","title":"constructor"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#ismulti","text":"\u2022 Readonly isMulti : boolean","title":"isMulti"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#name","text":"\u2022 Readonly name : string","title":"name"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#defaultvalue","text":"\u2022 get defaultValue (): V","title":"defaultValue"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#clear","text":"\u25b8 clear (): void","title":"clear"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#get","text":"\u25b8 get (): V","title":"get"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#getraw","text":"\u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search","title":"getRaw"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#parse","text":"\u25b8 parse ( values ): V","title":"parse"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#set","text":"\u25b8 set ( value , __namedParameters? ): void","title":"set"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#setraw","text":"\u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search","title":"setRaw"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#stringify","text":"\u25b8 stringify ( value? ): string []","title":"stringify"},{"location":"extensions/api/classes/renderer.navigation.pageparam/#tostring","text":"\u25b8 toString ( __namedParameters? ): string","title":"toString"},{"location":"extensions/api/enums/renderer.component.notificationstatus/","text":"Enumeration: NotificationStatus # Renderer . Component .NotificationStatus Table of contents # Enumeration members # ERROR INFO OK Enumeration members # ERROR # \u2022 ERROR = \"error\" INFO # \u2022 INFO = \"info\" OK # \u2022 OK = \"ok\"","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#enumeration-notificationstatus","text":"Renderer . Component .NotificationStatus","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#enumeration-members","text":"ERROR INFO OK","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#enumeration-members_1","text":"","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#error","text":"\u2022 ERROR = \"error\"","title":"ERROR"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#info","text":"\u2022 INFO = \"info\"","title":"INFO"},{"location":"extensions/api/enums/renderer.component.notificationstatus/#ok","text":"\u2022 OK = \"ok\"","title":"OK"},{"location":"extensions/api/enums/renderer.component.tooltipposition/","text":"Enumeration: TooltipPosition # Renderer . Component .TooltipPosition Table of contents # Enumeration members # BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT Enumeration members # BOTTOM # \u2022 BOTTOM = \"bottom\" BOTTOM_LEFT # \u2022 BOTTOM_LEFT = \"bottom_left\" BOTTOM_RIGHT # \u2022 BOTTOM_RIGHT = \"bottom_right\" LEFT # \u2022 LEFT = \"left\" RIGHT # \u2022 RIGHT = \"right\" TOP # \u2022 TOP = \"top\" TOP_LEFT # \u2022 TOP_LEFT = \"top_left\" TOP_RIGHT # \u2022 TOP_RIGHT = \"top_right\"","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#enumeration-tooltipposition","text":"Renderer . Component .TooltipPosition","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#enumeration-members","text":"BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#enumeration-members_1","text":"","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#bottom","text":"\u2022 BOTTOM = \"bottom\"","title":"BOTTOM"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#bottom_left","text":"\u2022 BOTTOM_LEFT = \"bottom_left\"","title":"BOTTOM_LEFT"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#bottom_right","text":"\u2022 BOTTOM_RIGHT = \"bottom_right\"","title":"BOTTOM_RIGHT"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#left","text":"\u2022 LEFT = \"left\"","title":"LEFT"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#right","text":"\u2022 RIGHT = \"right\"","title":"RIGHT"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#top","text":"\u2022 TOP = \"top\"","title":"TOP"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#top_left","text":"\u2022 TOP_LEFT = \"top_left\"","title":"TOP_LEFT"},{"location":"extensions/api/enums/renderer.component.tooltipposition/#top_right","text":"\u2022 TOP_RIGHT = \"top_right\"","title":"TOP_RIGHT"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/","text":"Enumeration: KubeObjectStatusLevel # Renderer . K8sApi .KubeObjectStatusLevel Table of contents # Enumeration members # CRITICAL INFO WARNING Enumeration members # CRITICAL # \u2022 CRITICAL = 3 INFO # \u2022 INFO = 1 WARNING # \u2022 WARNING = 2","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#enumeration-kubeobjectstatuslevel","text":"Renderer . K8sApi .KubeObjectStatusLevel","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#enumeration-members","text":"CRITICAL INFO WARNING","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#enumeration-members_1","text":"","title":"Enumeration members"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#critical","text":"\u2022 CRITICAL = 3","title":"CRITICAL"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#info","text":"\u2022 INFO = 1","title":"INFO"},{"location":"extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/#warning","text":"\u2022 WARNING = 2","title":"WARNING"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/","text":"Interface: CatalogCategoryEvents # Common . Catalog .CatalogCategoryEvents Table of contents # Properties # catalogAddMenu contextMenuOpen load Properties # catalogAddMenu # \u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void Type declaration # \u25b8 ( context ): void Parameters # Name Type context CatalogEntityAddMenuContext Returns # void contextMenuOpen # \u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void Type declaration # \u25b8 ( entity , context ): void Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > context CatalogEntityContextMenuContext Returns # void load # \u2022 load : () => void Type declaration # \u25b8 (): void Returns # void","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#interface-catalogcategoryevents","text":"Common . Catalog .CatalogCategoryEvents","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#properties","text":"catalogAddMenu contextMenuOpen load","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#catalogaddmenu","text":"\u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void","title":"catalogAddMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#contextmenuopen","text":"\u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void","title":"contextMenuOpen"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryevents/#load","text":"\u2022 load : () => void","title":"load"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/","text":"Interface: CatalogCategorySpec # Common . Catalog .CatalogCategorySpec Table of contents # Properties # group names versions Properties # group # \u2022 group : string names # \u2022 names : Object Type declaration # Name Type kind string versions # \u2022 versions : CatalogCategoryVersion < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[]","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#interface-catalogcategoryspec","text":"Common . Catalog .CatalogCategorySpec","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#properties","text":"group names versions","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#group","text":"\u2022 group : string","title":"group"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#names","text":"\u2022 names : Object","title":"names"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryspec/#versions","text":"\u2022 versions : CatalogCategoryVersion < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[]","title":"versions"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/","text":"Interface: CatalogCategoryVersion # Common . Catalog .CatalogCategoryVersion Type parameters # Name Type Entity Entity : CatalogEntity Table of contents # Properties # entityClass name Properties # entityClass # \u2022 entityClass : CatalogEntityConstructor name # \u2022 name : string","title":"Interface: CatalogCategoryVersion"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#interface-catalogcategoryversionentity","text":"Common . Catalog .CatalogCategoryVersion","title":"Interface: CatalogCategoryVersion<Entity>"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#type-parameters","text":"Name Type Entity Entity : CatalogEntity","title":"Type parameters"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#properties","text":"entityClass name","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#entityclass","text":"\u2022 entityClass : CatalogEntityConstructor ","title":"entityClass"},{"location":"extensions/api/interfaces/common.catalog.catalogcategoryversion/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/","text":"Interface: CatalogEntityActionContext # Common . Catalog .CatalogEntityActionContext Table of contents # Properties # navigate setCommandPaletteContext Properties # navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void setCommandPaletteContext # \u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void Type declaration # \u25b8 ( context? ): void Parameters # Name Type context? CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # void","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#interface-catalogentityactioncontext","text":"Common . Catalog .CatalogEntityActionContext","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#properties","text":"navigate setCommandPaletteContext","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/common.catalog.catalogentityactioncontext/#setcommandpalettecontext","text":"\u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void","title":"setCommandPaletteContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/","text":"Interface: CatalogEntityAddMenu # Common . Catalog .CatalogEntityAddMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm defaultAction icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string Inherited from # CatalogEntityContextMenu . confirm defaultAction # \u2022 Optional defaultAction : boolean icon # \u2022 icon : string Menu icon Overrides # CatalogEntityContextMenu . icon onClick # \u2022 onClick : () => void | Promise OnClick handler Type declaration # \u25b8 (): void | Promise Returns # void | Promise Inherited from # CatalogEntityContextMenu . onClick title # \u2022 title : string Menu title Inherited from # CatalogEntityContextMenu . title","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#interface-catalogentityaddmenu","text":"Common . Catalog .CatalogEntityAddMenu","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#properties","text":"confirm defaultAction icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#defaultaction","text":"\u2022 Optional defaultAction : boolean","title":"defaultAction"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#icon","text":"\u2022 icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#onclick","text":"\u2022 onClick : () => void | Promise OnClick handler","title":"onClick"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/","text":"Interface: CatalogEntityAddMenuContext # Common . Catalog .CatalogEntityAddMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityAddMenu [] navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#interface-catalogentityaddmenucontext","text":"Common . Catalog .CatalogEntityAddMenuContext","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#menuitems","text":"\u2022 menuItems : CatalogEntityAddMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/","text":"Interface: CatalogEntityContextMenu # Common . Catalog .CatalogEntityContextMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string icon # \u2022 Optional icon : string Menu icon onClick # \u2022 onClick : () => void | Promise OnClick handler Type declaration # \u25b8 (): void | Promise Returns # void | Promise title # \u2022 title : string Menu title","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#interface-catalogentitycontextmenu","text":"Common . Catalog .CatalogEntityContextMenu","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#properties","text":"confirm icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#icon","text":"\u2022 Optional icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#onclick","text":"\u2022 onClick : () => void | Promise OnClick handler","title":"onClick"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/","text":"Interface: CatalogEntityContextMenuContext # Common . Catalog .CatalogEntityContextMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu [] navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#interface-catalogentitycontextmenucontext","text":"Common . Catalog .CatalogEntityContextMenuContext","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/","text":"Interface: CatalogEntityData # Common . Catalog .CatalogEntityData Type parameters # Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec Table of contents # Properties # metadata spec status Properties # metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status","title":"Interface: CatalogEntityData"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#interface-catalogentitydatametadata-status-spec","text":"Common . Catalog .CatalogEntityData","title":"Interface: CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#type-parameters","text":"Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#properties","text":"metadata spec status","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/interfaces/common.catalog.catalogentitydata/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/","text":"Interface: CatalogEntityKindData # Common . Catalog .CatalogEntityKindData Implemented by # CatalogEntity Table of contents # Properties # apiVersion kind Properties # apiVersion # \u2022 Readonly apiVersion : string kind # \u2022 Readonly kind : string","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#interface-catalogentitykinddata","text":"Common . Catalog .CatalogEntityKindData","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#implemented-by","text":"CatalogEntity","title":"Implemented by"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#properties","text":"apiVersion kind","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/common.catalog.catalogentitykinddata/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/","text":"Interface: CatalogEntityMetadata # Common . Catalog .CatalogEntityMetadata Hierarchy # CatalogEntityMetadata \u21b3 KubernetesClusterMetadata Indexable # \u25aa [key: string ]: string | object Table of contents # Properties # description labels name source uid Properties # description # \u2022 Optional description : string labels # \u2022 labels : Record name # \u2022 name : string source # \u2022 Optional source : string uid # \u2022 uid : string","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#interface-catalogentitymetadata","text":"Common . Catalog .CatalogEntityMetadata","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#hierarchy","text":"CatalogEntityMetadata \u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#indexable","text":"\u25aa [key: string ]: string | object","title":"Indexable"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#properties","text":"description labels name source uid","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#labels","text":"\u2022 labels : Record ","title":"labels"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/common.catalog.catalogentitymetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/","text":"Interface: CatalogEntitySettingsContext # Common . Catalog .CatalogEntitySettingsContext Table of contents # Properties # menuItems Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu []","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/#interface-catalogentitysettingscontext","text":"Common . Catalog .CatalogEntitySettingsContext","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/#properties","text":"menuItems","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingscontext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/","text":"Interface: CatalogEntitySettingsMenu # Common . Catalog .CatalogEntitySettingsMenu Table of contents # Properties # components group title Properties # components # \u2022 components : Object Type declaration # Name Type View ComponentType group # \u2022 Optional group : string title # \u2022 title : string","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#interface-catalogentitysettingsmenu","text":"Common . Catalog .CatalogEntitySettingsMenu","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#properties","text":"components group title","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#components","text":"\u2022 components : Object","title":"components"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#group","text":"\u2022 Optional group : string","title":"group"},{"location":"extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/","text":"Interface: CatalogEntityStatus # Common . Catalog .CatalogEntityStatus Hierarchy # CatalogEntityStatus \u21b3 KubernetesClusterStatus \u21b3 WebLinkStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean enabled # \u2022 Optional enabled : boolean default true message # \u2022 Optional message : string phase # \u2022 phase : string reason # \u2022 Optional reason : string","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#interface-catalogentitystatus","text":"Common . Catalog .CatalogEntityStatus","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#hierarchy","text":"CatalogEntityStatus \u21b3 KubernetesClusterStatus \u21b3 WebLinkStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#enabled","text":"\u2022 Optional enabled : boolean default true","title":"enabled"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#phase","text":"\u2022 phase : string","title":"phase"},{"location":"extensions/api/interfaces/common.catalog.catalogentitystatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/","text":"Interface: KubernetesClusterMetadata # Common . Catalog .KubernetesClusterMetadata Hierarchy # CatalogEntityMetadata \u21b3 KubernetesClusterMetadata Table of contents # Properties # description distro kubeVersion labels name source uid Properties # description # \u2022 Optional description : string Inherited from # CatalogEntityMetadata . description distro # \u2022 Optional distro : string kubeVersion # \u2022 Optional kubeVersion : string labels # \u2022 labels : Record Inherited from # CatalogEntityMetadata . labels name # \u2022 name : string Inherited from # CatalogEntityMetadata . name source # \u2022 Optional source : string Inherited from # CatalogEntityMetadata . source uid # \u2022 uid : string Inherited from # CatalogEntityMetadata . uid","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#interface-kubernetesclustermetadata","text":"Common . Catalog .KubernetesClusterMetadata","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#hierarchy","text":"CatalogEntityMetadata \u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#properties","text":"description distro kubeVersion labels name source uid","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#distro","text":"\u2022 Optional distro : string","title":"distro"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#kubeversion","text":"\u2022 Optional kubeVersion : string","title":"kubeVersion"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#labels","text":"\u2022 labels : Record ","title":"labels"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclustermetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/","text":"Interface: KubernetesClusterPrometheusMetrics # Common . Catalog .KubernetesClusterPrometheusMetrics Table of contents # Properties # address type Properties # address # \u2022 Optional address : Object Type declaration # Name Type namespace string port number prefix string service string type # \u2022 Optional type : string","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#interface-kubernetesclusterprometheusmetrics","text":"Common . Catalog .KubernetesClusterPrometheusMetrics","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#properties","text":"address type","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#address","text":"\u2022 Optional address : Object","title":"address"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/","text":"Interface: KubernetesClusterSpec # Common . Catalog .KubernetesClusterSpec Hierarchy # CatalogEntitySpec \u21b3 KubernetesClusterSpec Table of contents # Properties # accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics Properties # accessibleNamespaces # \u2022 Optional accessibleNamespaces : string [] icon # \u2022 Optional icon : Object Type declaration # Name Type background? string material? string src? string kubeconfigContext # \u2022 kubeconfigContext : string kubeconfigPath # \u2022 kubeconfigPath : string metrics # \u2022 Optional metrics : Object Type declaration # Name Type prometheus? KubernetesClusterPrometheusMetrics source string","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#interface-kubernetesclusterspec","text":"Common . Catalog .KubernetesClusterSpec","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#hierarchy","text":"CatalogEntitySpec \u21b3 KubernetesClusterSpec","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#properties","text":"accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#accessiblenamespaces","text":"\u2022 Optional accessibleNamespaces : string []","title":"accessibleNamespaces"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#icon","text":"\u2022 Optional icon : Object","title":"icon"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#kubeconfigcontext","text":"\u2022 kubeconfigContext : string","title":"kubeconfigContext"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#kubeconfigpath","text":"\u2022 kubeconfigPath : string","title":"kubeconfigPath"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterspec/#metrics","text":"\u2022 Optional metrics : Object","title":"metrics"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/","text":"Interface: KubernetesClusterStatus # Common . Catalog .KubernetesClusterStatus Hierarchy # CatalogEntityStatus \u21b3 KubernetesClusterStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : KubernetesClusterStatusPhase Overrides # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#interface-kubernetesclusterstatus","text":"Common . Catalog .KubernetesClusterStatus","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#hierarchy","text":"CatalogEntityStatus \u21b3 KubernetesClusterStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#enabled","text":"\u2022 Optional enabled : boolean default true","title":"enabled"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#phase","text":"\u2022 phase : KubernetesClusterStatusPhase","title":"phase"},{"location":"extensions/api/interfaces/common.catalog.kubernetesclusterstatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/","text":"Interface: WebLinkStatus # Common . Catalog .WebLinkStatus Hierarchy # CatalogEntityStatus \u21b3 WebLinkStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : WebLinkStatusPhase Overrides # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#interface-weblinkstatus","text":"Common . Catalog .WebLinkStatus","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#hierarchy","text":"CatalogEntityStatus \u21b3 WebLinkStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#enabled","text":"\u2022 Optional enabled : boolean default true","title":"enabled"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#phase","text":"\u2022 phase : WebLinkStatusPhase","title":"phase"},{"location":"extensions/api/interfaces/common.catalog.weblinkstatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/","text":"Interface: AppPreferenceComponents # Common . Types .AppPreferenceComponents Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Table of contents # Properties # Hint Input Properties # Hint # \u2022 Hint : ComponentType Input # \u2022 Input : ComponentType ","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#interface-apppreferencecomponents","text":"Common . Types .AppPreferenceComponents Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#properties","text":"Hint Input","title":"Properties"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#hint","text":"\u2022 Hint : ComponentType ","title":"Hint"},{"location":"extensions/api/interfaces/common.types.apppreferencecomponents/#input","text":"\u2022 Input : ComponentType ","title":"Input"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/","text":"Interface: AppPreferenceRegistration # Common . Types .AppPreferenceRegistration Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Table of contents # Properties # components id showInPreferencesTab title Properties # components # \u2022 components : AppPreferenceComponents id # \u2022 Optional id : string showInPreferencesTab # \u2022 Optional showInPreferencesTab : string title # \u2022 title : string","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#interface-apppreferenceregistration","text":"Common . Types .AppPreferenceRegistration Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#properties","text":"components id showInPreferencesTab title","title":"Properties"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#components","text":"\u2022 components : AppPreferenceComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#showinpreferencestab","text":"\u2022 Optional showInPreferencesTab : string","title":"showInPreferencesTab"},{"location":"extensions/api/interfaces/common.types.apppreferenceregistration/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/","text":"Interface: ClusterPageMenuComponents # Common . Types .ClusterPageMenuComponents Table of contents # Properties # Icon Properties # Icon # \u2022 Icon : ComponentType < IconProps >","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/#interface-clusterpagemenucomponents","text":"Common . Types .ClusterPageMenuComponents","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/#properties","text":"Icon","title":"Properties"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.clusterpagemenucomponents/#icon","text":"\u2022 Icon : ComponentType < IconProps >","title":"Icon"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/","text":"Interface: ClusterPageMenuRegistration # Common . Types .ClusterPageMenuRegistration Table of contents # Properties # components id parentId target title Properties # components # \u2022 components : ClusterPageMenuComponents id # \u2022 Optional id : string parentId # \u2022 Optional parentId : string target # \u2022 Optional target : PageTarget title # \u2022 title : ReactNode","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#interface-clusterpagemenuregistration","text":"Common . Types .ClusterPageMenuRegistration","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#properties","text":"components id parentId target title","title":"Properties"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#components","text":"\u2022 components : ClusterPageMenuComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#parentid","text":"\u2022 Optional parentId : string","title":"parentId"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#target","text":"\u2022 Optional target : PageTarget","title":"target"},{"location":"extensions/api/interfaces/common.types.clusterpagemenuregistration/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/","text":"Interface: KubeObjectDetailComponents # Common . Types .KubeObjectDetailComponents Type parameters # Name Type T T : KubeObject = KubeObject Table of contents # Properties # Details Properties # Details # \u2022 Details : ComponentType < KubeObjectDetailsProps >","title":"Interface: KubeObjectDetailComponents"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#interface-kubeobjectdetailcomponentst","text":"Common . Types .KubeObjectDetailComponents","title":"Interface: KubeObjectDetailComponents<T>"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#type-parameters","text":"Name Type T T : KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#properties","text":"Details","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailcomponents/#details","text":"\u2022 Details : ComponentType < KubeObjectDetailsProps >","title":"Details"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/","text":"Interface: KubeObjectDetailRegistration # Common . Types .KubeObjectDetailRegistration Table of contents # Properties # apiVersions components kind priority Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectDetailComponents < KubeObject > kind # \u2022 kind : string priority # \u2022 Optional priority : number","title":"Interface: KubeObjectDetailRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#interface-kubeobjectdetailregistration","text":"Common . Types .KubeObjectDetailRegistration","title":"Interface: KubeObjectDetailRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#properties","text":"apiVersions components kind priority","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#components","text":"\u2022 components : KubeObjectDetailComponents < KubeObject >","title":"components"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/common.types.kubeobjectdetailregistration/#priority","text":"\u2022 Optional priority : number","title":"priority"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/","text":"Interface: KubeObjectMenuComponents # Common . Types .KubeObjectMenuComponents Table of contents # Properties # MenuItem Properties # MenuItem # \u2022 MenuItem : ComponentType ","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/#interface-kubeobjectmenucomponents","text":"Common . Types .KubeObjectMenuComponents","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/#properties","text":"MenuItem","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenucomponents/#menuitem","text":"\u2022 MenuItem : ComponentType ","title":"MenuItem"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/","text":"Interface: KubeObjectMenuRegistration # Common . Types .KubeObjectMenuRegistration Table of contents # Properties # apiVersions components kind Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectMenuComponents kind # \u2022 kind : string","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#interface-kubeobjectmenuregistration","text":"Common . Types .KubeObjectMenuRegistration","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#properties","text":"apiVersions components kind","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#components","text":"\u2022 components : KubeObjectMenuComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.kubeobjectmenuregistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/","text":"Interface: KubeObjectStatusRegistration # Common . Types .KubeObjectStatusRegistration Table of contents # Properties # apiVersions kind resolve Properties # apiVersions # \u2022 apiVersions : string [] kind # \u2022 kind : string resolve # \u2022 resolve : ( object : KubeObject ) => KubeObjectStatus Type declaration # \u25b8 ( object ): KubeObjectStatus Parameters # Name Type object KubeObject Returns # KubeObjectStatus","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#interface-kubeobjectstatusregistration","text":"Common . Types .KubeObjectStatusRegistration","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#properties","text":"apiVersions kind resolve","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/common.types.kubeobjectstatusregistration/#resolve","text":"\u2022 resolve : ( object : KubeObject ) => KubeObjectStatus","title":"resolve"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/","text":"Interface: PageComponentProps

# Common . Types .PageComponentProps Type parameters # Name Type P P : PageParams = {} Table of contents # Properties # params Properties # params # \u2022 Optional params : { [N in string | number | symbol]: PageParam}","title":"Interface: PageComponentProps"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#interface-pagecomponentpropsp","text":"Common . Types .PageComponentProps","title":"Interface: PageComponentProps<P>"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#type-parameters","text":"Name Type P P : PageParams = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#properties","text":"params","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagecomponentprops/#params","text":"\u2022 Optional params : { [N in string | number | symbol]: PageParam}","title":"params"},{"location":"extensions/api/interfaces/common.types.pagecomponents/","text":"Interface: PageComponents # Common . Types .PageComponents Table of contents # Properties # Page Properties # Page # \u2022 Page : ComponentType ","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/common.types.pagecomponents/#interface-pagecomponents","text":"Common . Types .PageComponents","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/common.types.pagecomponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.pagecomponents/#properties","text":"Page","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagecomponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagecomponents/#page","text":"\u2022 Page : ComponentType ","title":"Page"},{"location":"extensions/api/interfaces/common.types.pageparams/","text":"Interface: PageParams # Common . Types .PageParams Type parameters # Name Type V V = any Indexable # \u25aa [paramName: string ]: V","title":"Interface: PageParams"},{"location":"extensions/api/interfaces/common.types.pageparams/#interface-pageparamsv","text":"Common . Types .PageParams","title":"Interface: PageParams<V>"},{"location":"extensions/api/interfaces/common.types.pageparams/#type-parameters","text":"Name Type V V = any","title":"Type parameters"},{"location":"extensions/api/interfaces/common.types.pageparams/#indexable","text":"\u25aa [paramName: string ]: V","title":"Indexable"},{"location":"extensions/api/interfaces/common.types.pageregistration/","text":"Interface: PageRegistration # Common . Types .PageRegistration Table of contents # Properties # components id params Properties # components # \u2022 components : PageComponents id # \u2022 Optional id : string 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 params # \u2022 Optional params : PageParams , \"name\" | \"prefix\" >>","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/common.types.pageregistration/#interface-pageregistration","text":"Common . Types .PageRegistration","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/common.types.pageregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.pageregistration/#properties","text":"components id params","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pageregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pageregistration/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.pageregistration/#id","text":"\u2022 Optional id : string 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","title":"id"},{"location":"extensions/api/interfaces/common.types.pageregistration/#params","text":"\u2022 Optional params : PageParams , \"name\" | \"prefix\" >>","title":"params"},{"location":"extensions/api/interfaces/common.types.pagetarget/","text":"Interface: PageTarget # Common . Types .PageTarget Table of contents # Properties # extensionId pageId params Properties # extensionId # \u2022 Optional extensionId : string pageId # \u2022 Optional pageId : string params # \u2022 Optional params : PageParams ","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/common.types.pagetarget/#interface-pagetarget","text":"Common . Types .PageTarget","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/common.types.pagetarget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.pagetarget/#properties","text":"extensionId pageId params","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagetarget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.pagetarget/#extensionid","text":"\u2022 Optional extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/common.types.pagetarget/#pageid","text":"\u2022 Optional pageId : string","title":"pageId"},{"location":"extensions/api/interfaces/common.types.pagetarget/#params","text":"\u2022 Optional params : PageParams ","title":"params"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/","text":"Interface: ProtocolHandlerRegistration # Common . Types .ProtocolHandlerRegistration ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path. Table of contents # Properties # handler pathSchema Properties # handler # \u2022 handler : ProtocolRouteHandler pathSchema # \u2022 pathSchema : string","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#interface-protocolhandlerregistration","text":"Common . Types .ProtocolHandlerRegistration ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path.","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#properties","text":"handler pathSchema","title":"Properties"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#handler","text":"\u2022 handler : ProtocolRouteHandler","title":"handler"},{"location":"extensions/api/interfaces/common.types.protocolhandlerregistration/#pathschema","text":"\u2022 pathSchema : string","title":"pathSchema"},{"location":"extensions/api/interfaces/common.types.protocolroutehandler/","text":"Interface: ProtocolRouteHandler # Common . Types .ProtocolRouteHandler RouteHandler represents the function signature of the handler function for lens:// protocol routing. Callable # ProtocolRouteHandler # \u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing. Parameters # Name Type params ProtocolRouteParams Returns # void","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/common.types.protocolroutehandler/#interface-protocolroutehandler","text":"Common . Types .ProtocolRouteHandler RouteHandler represents the function signature of the handler function for lens:// protocol routing.","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/common.types.protocolroutehandler/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/common.types.protocolroutehandler/#protocolroutehandler","text":"\u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing.","title":"ProtocolRouteHandler"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/","text":"Interface: ProtocolRouteParams # Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request Table of contents # Properties # pathname search tail Properties # pathname # \u2022 pathname : Record the matching parts of the path. The dynamic parts of the URI path. search # \u2022 search : Record the parts of the URI query string tail # \u2022 Optional tail : string 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\" .","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#interface-protocolrouteparams","text":"Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#properties","text":"pathname search tail","title":"Properties"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#pathname","text":"\u2022 pathname : Record the matching parts of the path. The dynamic parts of the URI path.","title":"pathname"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#search","text":"\u2022 search : Record the parts of the URI query string","title":"search"},{"location":"extensions/api/interfaces/common.types.protocolrouteparams/#tail","text":"\u2022 Optional tail : string 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\" .","title":"tail"},{"location":"extensions/api/interfaces/common.types.registeredpage/","text":"Interface: RegisteredPage # Common . Types .RegisteredPage Table of contents # Properties # components extensionId id params url Properties # components # \u2022 components : PageComponents extensionId # \u2022 extensionId : string id # \u2022 id : string params # \u2022 params : PageParams < PageParam > url # \u2022 url : string","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/common.types.registeredpage/#interface-registeredpage","text":"Common . Types .RegisteredPage","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/common.types.registeredpage/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.registeredpage/#properties","text":"components extensionId id params url","title":"Properties"},{"location":"extensions/api/interfaces/common.types.registeredpage/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.registeredpage/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.registeredpage/#extensionid","text":"\u2022 extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/common.types.registeredpage/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/interfaces/common.types.registeredpage/#params","text":"\u2022 params : PageParams < PageParam >","title":"params"},{"location":"extensions/api/interfaces/common.types.registeredpage/#url","text":"\u2022 url : string","title":"url"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/","text":"Interface: StatusBarRegistration # Common . Types .StatusBarRegistration Hierarchy # StatusBarRegistrationV2 \u21b3 StatusBarRegistration Table of contents # Properties # components item Properties # components # \u2022 Optional components : StatusBarComponents Inherited from # StatusBarRegistrationV2.components item # \u2022 Optional item : ReactNode deprecated use components.Item instead","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#interface-statusbarregistration","text":"Common . Types .StatusBarRegistration","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#hierarchy","text":"StatusBarRegistrationV2 \u21b3 StatusBarRegistration","title":"Hierarchy"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#properties","text":"components item","title":"Properties"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#components","text":"\u2022 Optional components : StatusBarComponents","title":"components"},{"location":"extensions/api/interfaces/common.types.statusbarregistration/#item","text":"\u2022 Optional item : ReactNode deprecated use components.Item instead","title":"item"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/","text":"Interface: BadgeProps # Renderer . Component .BadgeProps Hierarchy # HTMLAttributes TooltipDecoratorProps \u21b3 BadgeProps Table of contents # Properties # about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable expandable flat hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType label lang onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security slot small spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab Properties # about # \u2022 Optional about : string Inherited from # React.HTMLAttributes.about accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLAttributes.accessKey aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLAttributes.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLAttributes.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLAttributes.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLAttributes.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLAttributes.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLAttributes.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLAttributes.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLAttributes.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLAttributes.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLAttributes.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLAttributes.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLAttributes.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLAttributes.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLAttributes.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLAttributes.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLAttributes.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLAttributes.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLAttributes.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLAttributes.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLAttributes.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLAttributes.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLAttributes.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLAttributes.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLAttributes.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLAttributes.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLAttributes.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLAttributes.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLAttributes.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLAttributes.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLAttributes.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLAttributes.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLAttributes.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLAttributes.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLAttributes.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLAttributes.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLAttributes.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLAttributes.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLAttributes.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLAttributes.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLAttributes.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLAttributes.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLAttributes.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLAttributes.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLAttributes.autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLAttributes.autoSave children # \u2022 Optional children : ReactNode Inherited from # React.HTMLAttributes.children className # \u2022 Optional className : string Inherited from # React.HTMLAttributes.className color # \u2022 Optional color : string Inherited from # React.HTMLAttributes.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLAttributes.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLAttributes.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLAttributes.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # React.HTMLAttributes.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLAttributes.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLAttributes.defaultValue dir # \u2022 Optional dir : string Inherited from # React.HTMLAttributes.dir disabled # \u2022 Optional disabled : boolean draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLAttributes.draggable expandable # \u2022 Optional expandable : boolean flat # \u2022 Optional flat : boolean hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLAttributes.hidden id # \u2022 Optional id : string Inherited from # React.HTMLAttributes.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLAttributes.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLAttributes.inputMode is # \u2022 Optional is : string 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 Inherited from # React.HTMLAttributes.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLAttributes.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLAttributes.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLAttributes.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLAttributes.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLAttributes.itemType label # \u2022 Optional label : ReactNode lang # \u2022 Optional lang : string Inherited from # React.HTMLAttributes.lang onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLAttributes.onWheelCapture placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLAttributes.placeholder prefix # \u2022 Optional prefix : string Inherited from # React.HTMLAttributes.prefix property # \u2022 Optional property : string Inherited from # React.HTMLAttributes.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLAttributes.radioGroup resource # \u2022 Optional resource : string Inherited from # React.HTMLAttributes.resource results # \u2022 Optional results : number Inherited from # React.HTMLAttributes.results role # \u2022 Optional role : string Inherited from # React.HTMLAttributes.role security # \u2022 Optional security : string Inherited from # React.HTMLAttributes.security slot # \u2022 Optional slot : string Inherited from # React.HTMLAttributes.slot small # \u2022 Optional small : boolean spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLAttributes.spellCheck style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLAttributes.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLAttributes.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLAttributes.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLAttributes.tabIndex title # \u2022 Optional title : string Inherited from # React.HTMLAttributes.title tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > Inherited from # TooltipDecoratorProps . tooltip tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\" Inherited from # TooltipDecoratorProps . tooltipOverrideDisabled translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLAttributes.translate typeof # \u2022 Optional typeof : string Inherited from # React.HTMLAttributes.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLAttributes.unselectable vocab # \u2022 Optional vocab : string Inherited from # React.HTMLAttributes.vocab","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#interface-badgeprops","text":"Renderer . Component .BadgeProps","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#hierarchy","text":"HTMLAttributes TooltipDecoratorProps \u21b3 BadgeProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#properties","text":"about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable expandable flat hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType label lang onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security slot small spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#expandable","text":"\u2022 Optional expandable : boolean","title":"expandable"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#flat","text":"\u2022 Optional flat : boolean","title":"flat"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.badgeprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/","text":"Interface: ButtonProps # Renderer . Component .ButtonProps Hierarchy # ButtonHTMLAttributes TooltipDecoratorProps \u21b3 ButtonProps Table of contents # Properties # about accent accessKey active aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoFocus autoSave big children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable form formAction formEncType formMethod formNoValidate formTarget hidden href id inlist inputMode is itemID itemProp itemRef itemScope itemType label lang light name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture outlined placeholder plain prefix primary property radioGroup resource results role round security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex target title tooltip tooltipOverrideDisabled translate type typeof unselectable value vocab waiting Properties # about # \u2022 Optional about : string Inherited from # ButtonHTMLAttributes.about accent # \u2022 Optional accent : boolean accessKey # \u2022 Optional accessKey : string Inherited from # ButtonHTMLAttributes.accessKey active # \u2022 Optional active : boolean aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # ButtonHTMLAttributes.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # ButtonHTMLAttributes.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # ButtonHTMLAttributes.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # ButtonHTMLAttributes.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # ButtonHTMLAttributes.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # ButtonHTMLAttributes.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # ButtonHTMLAttributes.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # ButtonHTMLAttributes.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # ButtonHTMLAttributes.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # ButtonHTMLAttributes.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # ButtonHTMLAttributes.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # ButtonHTMLAttributes.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # ButtonHTMLAttributes.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # ButtonHTMLAttributes.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # ButtonHTMLAttributes.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # ButtonHTMLAttributes.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # ButtonHTMLAttributes.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # ButtonHTMLAttributes.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # ButtonHTMLAttributes.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # ButtonHTMLAttributes.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # ButtonHTMLAttributes.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # ButtonHTMLAttributes.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # ButtonHTMLAttributes.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # ButtonHTMLAttributes.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # ButtonHTMLAttributes.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # ButtonHTMLAttributes.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # ButtonHTMLAttributes.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # ButtonHTMLAttributes.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # ButtonHTMLAttributes.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # ButtonHTMLAttributes.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # ButtonHTMLAttributes.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # ButtonHTMLAttributes.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # ButtonHTMLAttributes.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # ButtonHTMLAttributes.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # ButtonHTMLAttributes.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # ButtonHTMLAttributes.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # ButtonHTMLAttributes.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # ButtonHTMLAttributes.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # ButtonHTMLAttributes.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # ButtonHTMLAttributes.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # ButtonHTMLAttributes.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # ButtonHTMLAttributes.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # ButtonHTMLAttributes.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # ButtonHTMLAttributes.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # ButtonHTMLAttributes.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # ButtonHTMLAttributes.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # ButtonHTMLAttributes.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # ButtonHTMLAttributes.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # ButtonHTMLAttributes.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # ButtonHTMLAttributes.autoCorrect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # ButtonHTMLAttributes.autoFocus autoSave # \u2022 Optional autoSave : string Inherited from # ButtonHTMLAttributes.autoSave big # \u2022 Optional big : boolean children # \u2022 Optional children : ReactNode Inherited from # ButtonHTMLAttributes.children className # \u2022 Optional className : string Inherited from # ButtonHTMLAttributes.className color # \u2022 Optional color : string Inherited from # ButtonHTMLAttributes.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # ButtonHTMLAttributes.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # ButtonHTMLAttributes.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # ButtonHTMLAttributes.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # ButtonHTMLAttributes.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # ButtonHTMLAttributes.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # ButtonHTMLAttributes.defaultValue dir # \u2022 Optional dir : string Inherited from # ButtonHTMLAttributes.dir disabled # \u2022 Optional disabled : boolean Inherited from # ButtonHTMLAttributes.disabled draggable # \u2022 Optional draggable : Booleanish Inherited from # ButtonHTMLAttributes.draggable form # \u2022 Optional form : string Inherited from # ButtonHTMLAttributes.form formAction # \u2022 Optional formAction : string Inherited from # ButtonHTMLAttributes.formAction formEncType # \u2022 Optional formEncType : string Inherited from # ButtonHTMLAttributes.formEncType formMethod # \u2022 Optional formMethod : string Inherited from # ButtonHTMLAttributes.formMethod formNoValidate # \u2022 Optional formNoValidate : boolean Inherited from # ButtonHTMLAttributes.formNoValidate formTarget # \u2022 Optional formTarget : string Inherited from # ButtonHTMLAttributes.formTarget hidden # \u2022 Optional hidden : boolean Overrides # ButtonHTMLAttributes.hidden href # \u2022 Optional href : string id # \u2022 Optional id : string Inherited from # ButtonHTMLAttributes.id inlist # \u2022 Optional inlist : any Inherited from # ButtonHTMLAttributes.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # ButtonHTMLAttributes.inputMode is # \u2022 Optional is : string 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 Inherited from # ButtonHTMLAttributes.is itemID # \u2022 Optional itemID : string Inherited from # ButtonHTMLAttributes.itemID itemProp # \u2022 Optional itemProp : string Inherited from # ButtonHTMLAttributes.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # ButtonHTMLAttributes.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # ButtonHTMLAttributes.itemScope itemType # \u2022 Optional itemType : string Inherited from # ButtonHTMLAttributes.itemType label # \u2022 Optional label : ReactNode lang # \u2022 Optional lang : string Inherited from # ButtonHTMLAttributes.lang light # \u2022 Optional light : boolean name # \u2022 Optional name : string Inherited from # ButtonHTMLAttributes.name onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # ButtonHTMLAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # ButtonHTMLAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # ButtonHTMLAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # ButtonHTMLAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # ButtonHTMLAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # ButtonHTMLAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # ButtonHTMLAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # ButtonHTMLAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # ButtonHTMLAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # ButtonHTMLAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # ButtonHTMLAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # ButtonHTMLAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # ButtonHTMLAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # ButtonHTMLAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # ButtonHTMLAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # ButtonHTMLAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # ButtonHTMLAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # ButtonHTMLAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # ButtonHTMLAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # ButtonHTMLAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # ButtonHTMLAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # ButtonHTMLAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # ButtonHTMLAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # ButtonHTMLAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # ButtonHTMLAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # ButtonHTMLAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # ButtonHTMLAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # ButtonHTMLAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # ButtonHTMLAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # ButtonHTMLAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # ButtonHTMLAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # ButtonHTMLAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # ButtonHTMLAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # ButtonHTMLAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # ButtonHTMLAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # ButtonHTMLAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # ButtonHTMLAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # ButtonHTMLAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # ButtonHTMLAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # ButtonHTMLAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # ButtonHTMLAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # ButtonHTMLAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # ButtonHTMLAttributes.onWheelCapture outlined # \u2022 Optional outlined : boolean placeholder # \u2022 Optional placeholder : string Inherited from # ButtonHTMLAttributes.placeholder plain # \u2022 Optional plain : boolean prefix # \u2022 Optional prefix : string Inherited from # ButtonHTMLAttributes.prefix primary # \u2022 Optional primary : boolean property # \u2022 Optional property : string Inherited from # ButtonHTMLAttributes.property radioGroup # \u2022 Optional radioGroup : string Inherited from # ButtonHTMLAttributes.radioGroup resource # \u2022 Optional resource : string Inherited from # ButtonHTMLAttributes.resource results # \u2022 Optional results : number Inherited from # ButtonHTMLAttributes.results role # \u2022 Optional role : string Inherited from # ButtonHTMLAttributes.role round # \u2022 Optional round : boolean security # \u2022 Optional security : string Inherited from # ButtonHTMLAttributes.security slot # \u2022 Optional slot : string Inherited from # ButtonHTMLAttributes.slot spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # ButtonHTMLAttributes.spellCheck style # \u2022 Optional style : CSSProperties Inherited from # ButtonHTMLAttributes.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # ButtonHTMLAttributes.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # ButtonHTMLAttributes.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # ButtonHTMLAttributes.tabIndex target # \u2022 Optional target : \"_blank\" title # \u2022 Optional title : string Inherited from # ButtonHTMLAttributes.title tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > Inherited from # TooltipDecoratorProps . tooltip tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\" Inherited from # TooltipDecoratorProps . tooltipOverrideDisabled translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # ButtonHTMLAttributes.translate type # \u2022 Optional type : \"submit\" | \"reset\" | \"button\" Inherited from # ButtonHTMLAttributes.type typeof # \u2022 Optional typeof : string Inherited from # ButtonHTMLAttributes.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # ButtonHTMLAttributes.unselectable value # \u2022 Optional value : string | number | readonly string [] Inherited from # ButtonHTMLAttributes.value vocab # \u2022 Optional vocab : string Inherited from # ButtonHTMLAttributes.vocab waiting # \u2022 Optional waiting : boolean","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#interface-buttonprops","text":"Renderer . Component .ButtonProps","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#hierarchy","text":"ButtonHTMLAttributes TooltipDecoratorProps \u21b3 ButtonProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#properties","text":"about accent accessKey active aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoFocus autoSave big children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable form formAction formEncType formMethod formNoValidate formTarget hidden href id inlist inputMode is itemID itemProp itemRef itemScope itemType label lang light name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture outlined placeholder plain prefix primary property radioGroup resource results role round security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex target title tooltip tooltipOverrideDisabled translate type typeof unselectable value vocab waiting","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#accent","text":"\u2022 Optional accent : boolean","title":"accent"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#big","text":"\u2022 Optional big : boolean","title":"big"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#form","text":"\u2022 Optional form : string","title":"form"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#formaction","text":"\u2022 Optional formAction : string","title":"formAction"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#formenctype","text":"\u2022 Optional formEncType : string","title":"formEncType"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#formmethod","text":"\u2022 Optional formMethod : string","title":"formMethod"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#formnovalidate","text":"\u2022 Optional formNoValidate : boolean","title":"formNoValidate"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#formtarget","text":"\u2022 Optional formTarget : string","title":"formTarget"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#light","text":"\u2022 Optional light : boolean","title":"light"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#outlined","text":"\u2022 Optional outlined : boolean","title":"outlined"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#plain","text":"\u2022 Optional plain : boolean","title":"plain"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#primary","text":"\u2022 Optional primary : boolean","title":"primary"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#round","text":"\u2022 Optional round : boolean","title":"round"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#target","text":"\u2022 Optional target : \"_blank\"","title":"target"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#type","text":"\u2022 Optional type : \"submit\" | \"reset\" | \"button\"","title":"type"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#value","text":"\u2022 Optional value : string | number | readonly string []","title":"value"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.buttonprops/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/","text":"Interface: CheckboxProps # Renderer . Component .CheckboxProps Type parameters # Name Type T T = boolean Table of contents # Properties # className disabled inline label theme value Methods # onChange Properties # className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean inline # \u2022 Optional inline : boolean label # \u2022 Optional label : ReactNode theme # \u2022 Optional theme : \"light\" | \"dark\" value # \u2022 Optional value : T Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value T evt ChangeEvent Returns # void","title":"Interface: CheckboxProps"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#interface-checkboxpropst","text":"Renderer . Component .CheckboxProps","title":"Interface: CheckboxProps<T>"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#type-parameters","text":"Name Type T T = boolean","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#properties","text":"className disabled inline label theme value","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#inline","text":"\u2022 Optional inline : boolean","title":"inline"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#theme","text":"\u2022 Optional theme : \"light\" | \"dark\"","title":"theme"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#value","text":"\u2022 Optional value : T","title":"value"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.checkboxprops/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/","text":"Interface: ConfirmDialogBooleanParams # Renderer . Component .ConfirmDialogBooleanParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancelButtonProps icon labelCancel labelOk message okButtonProps Properties # cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > icon # \u2022 Optional icon : ReactNode labelCancel # \u2022 Optional labelCancel : ReactNode labelOk # \u2022 Optional labelOk : ReactNode message # \u2022 message : ReactNode okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps >","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#interface-confirmdialogbooleanparams","text":"Renderer . Component .ConfirmDialogBooleanParams","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#properties","text":"cancelButtonProps icon labelCancel labelOk message okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/","text":"Interface: ConfirmDialogParams # Renderer . Component .ConfirmDialogParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps Properties # cancel # \u2022 Optional cancel : () => any Type declaration # \u25b8 (): any Returns # any cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . cancelButtonProps icon # \u2022 Optional icon : ReactNode Inherited from # ConfirmDialogBooleanParams . icon labelCancel # \u2022 Optional labelCancel : ReactNode Inherited from # ConfirmDialogBooleanParams . labelCancel labelOk # \u2022 Optional labelOk : ReactNode Inherited from # ConfirmDialogBooleanParams . labelOk message # \u2022 message : ReactNode Inherited from # ConfirmDialogBooleanParams . message ok # \u2022 Optional ok : () => any Type declaration # \u25b8 (): any Returns # any okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . okButtonProps","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#interface-confirmdialogparams","text":"Renderer . Component .ConfirmDialogParams","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#properties","text":"cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#cancel","text":"\u2022 Optional cancel : () => any","title":"cancel"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#ok","text":"\u2022 Optional ok : () => any","title":"ok"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogparams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/","text":"Interface: ConfirmDialogProps # Renderer . Component .ConfirmDialogProps Hierarchy # Partial < DialogProps > \u21b3 ConfirmDialogProps Table of contents # Properties # animated className close isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean Inherited from # Partial.animated className # \u2022 Optional className : string Inherited from # Partial.className close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.close isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen modal # \u2022 Optional modal : boolean Inherited from # Partial.modal onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onClose onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onOpen open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.open pinned # \u2022 Optional pinned : boolean Inherited from # Partial.pinned","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#interface-confirmdialogprops","text":"Renderer . Component .ConfirmDialogProps","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#hierarchy","text":"Partial < DialogProps > \u21b3 ConfirmDialogProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#properties","text":"animated className close isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/renderer.component.confirmdialogprops/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/","text":"Interface: DialogProps # Renderer . Component .DialogProps Table of contents # Properties # animated className close isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean className # \u2022 Optional className : string close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void isOpen # \u2022 Optional isOpen : boolean modal # \u2022 Optional modal : boolean onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void pinned # \u2022 Optional pinned : boolean","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#interface-dialogprops","text":"Renderer . Component .DialogProps","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#properties","text":"animated className close isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/renderer.component.dialogprops/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/","text":"Interface: DrawerItemLabelsProps # Renderer . Component .DrawerItemLabelsProps Hierarchy # DrawerItemProps \u21b3 DrawerItemLabelsProps Table of contents # Properties # about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType labels labelsOnly lang name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup renderBoolean resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title translate typeof unselectable vocab Properties # about # \u2022 Optional about : string Inherited from # DrawerItemProps . about accessKey # \u2022 Optional accessKey : string Inherited from # DrawerItemProps . accessKey aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # DrawerItemProps . aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # DrawerItemProps . aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # DrawerItemProps . aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # DrawerItemProps . aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # DrawerItemProps . aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # DrawerItemProps . aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # DrawerItemProps . aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # DrawerItemProps . aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # DrawerItemProps . aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # DrawerItemProps . aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # DrawerItemProps . aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # DrawerItemProps . aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # DrawerItemProps . aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # DrawerItemProps . aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # DrawerItemProps . aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # DrawerItemProps . aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # DrawerItemProps . aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # DrawerItemProps . aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # DrawerItemProps . aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # DrawerItemProps . aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # DrawerItemProps . aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # DrawerItemProps . aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # DrawerItemProps . aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # DrawerItemProps . aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # DrawerItemProps . aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # DrawerItemProps . aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # DrawerItemProps . aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # DrawerItemProps . aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # DrawerItemProps . aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # DrawerItemProps . aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # DrawerItemProps . aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # DrawerItemProps . aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # DrawerItemProps . aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # DrawerItemProps . aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # DrawerItemProps . aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # DrawerItemProps . aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # DrawerItemProps . aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # DrawerItemProps . aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # DrawerItemProps . aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # DrawerItemProps . aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # DrawerItemProps . aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # DrawerItemProps . aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # DrawerItemProps . aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # DrawerItemProps . aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # DrawerItemProps . aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # DrawerItemProps . aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # DrawerItemProps . aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # DrawerItemProps . aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # DrawerItemProps . autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # DrawerItemProps . autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # DrawerItemProps . autoSave children # \u2022 Optional children : ReactNode Inherited from # DrawerItemProps . children className # \u2022 Optional className : string Inherited from # DrawerItemProps . className color # \u2022 Optional color : string Inherited from # DrawerItemProps . color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # DrawerItemProps . contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # DrawerItemProps . contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # DrawerItemProps . dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # DrawerItemProps . datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # DrawerItemProps . defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # DrawerItemProps . defaultValue dir # \u2022 Optional dir : string Inherited from # DrawerItemProps . dir draggable # \u2022 Optional draggable : Booleanish Inherited from # DrawerItemProps . draggable hidden # \u2022 Optional hidden : boolean Inherited from # DrawerItemProps . hidden id # \u2022 Optional id : string Inherited from # DrawerItemProps . id inlist # \u2022 Optional inlist : any Inherited from # DrawerItemProps . inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # DrawerItemProps . inputMode is # \u2022 Optional is : string 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 Inherited from # DrawerItemProps . is itemID # \u2022 Optional itemID : string Inherited from # DrawerItemProps . itemID itemProp # \u2022 Optional itemProp : string Inherited from # DrawerItemProps . itemProp itemRef # \u2022 Optional itemRef : string Inherited from # DrawerItemProps . itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # DrawerItemProps . itemScope itemType # \u2022 Optional itemType : string Inherited from # DrawerItemProps . itemType labels # \u2022 labels : string [] labelsOnly # \u2022 Optional labelsOnly : boolean Inherited from # DrawerItemProps . labelsOnly lang # \u2022 Optional lang : string Inherited from # DrawerItemProps . lang name # \u2022 name : ReactNode Inherited from # DrawerItemProps . name onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # DrawerItemProps . onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # DrawerItemProps . onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # DrawerItemProps . onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # DrawerItemProps . onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # DrawerItemProps . onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # DrawerItemProps . onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # DrawerItemProps . onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # DrawerItemProps . onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # DrawerItemProps . onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # DrawerItemProps . onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # DrawerItemProps . onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # DrawerItemProps . onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # DrawerItemProps . onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # DrawerItemProps . onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # DrawerItemProps . onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # DrawerItemProps . onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # DrawerItemProps . onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # DrawerItemProps . onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # DrawerItemProps . onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # DrawerItemProps . onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # DrawerItemProps . onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # DrawerItemProps . onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # DrawerItemProps . onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # DrawerItemProps . onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # DrawerItemProps . onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # DrawerItemProps . onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # DrawerItemProps . onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # DrawerItemProps . onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # DrawerItemProps . onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # DrawerItemProps . onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # DrawerItemProps . onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # DrawerItemProps . onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # DrawerItemProps . onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # DrawerItemProps . onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # DrawerItemProps . onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # DrawerItemProps . onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # DrawerItemProps . onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # DrawerItemProps . onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # DrawerItemProps . onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # DrawerItemProps . onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # DrawerItemProps . onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # DrawerItemProps . onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # DrawerItemProps . onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # DrawerItemProps . onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # DrawerItemProps . onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # DrawerItemProps . onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # DrawerItemProps . onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # DrawerItemProps . onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # DrawerItemProps . onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # DrawerItemProps . onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # DrawerItemProps . onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # DrawerItemProps . onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # DrawerItemProps . onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # DrawerItemProps . onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # DrawerItemProps . onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # DrawerItemProps . onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # DrawerItemProps . onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # DrawerItemProps . onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # DrawerItemProps . onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # DrawerItemProps . onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # DrawerItemProps . onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # DrawerItemProps . onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # DrawerItemProps . onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # DrawerItemProps . onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # DrawerItemProps . onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # DrawerItemProps . onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # DrawerItemProps . onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # DrawerItemProps . onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # DrawerItemProps . onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # DrawerItemProps . onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # DrawerItemProps . onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # DrawerItemProps . onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # DrawerItemProps . onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # DrawerItemProps . onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # DrawerItemProps . onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # DrawerItemProps . onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # DrawerItemProps . onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # DrawerItemProps . onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # DrawerItemProps . onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # DrawerItemProps . onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # DrawerItemProps . onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # DrawerItemProps . onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # DrawerItemProps . onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # DrawerItemProps . onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # DrawerItemProps . onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # DrawerItemProps . onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # DrawerItemProps . onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # DrawerItemProps . onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # DrawerItemProps . onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # DrawerItemProps . onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # DrawerItemProps . onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # DrawerItemProps . onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # DrawerItemProps . onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # DrawerItemProps . onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # DrawerItemProps . onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # DrawerItemProps . onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # DrawerItemProps . onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # DrawerItemProps . onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # DrawerItemProps . onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # DrawerItemProps . onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # DrawerItemProps . onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # DrawerItemProps . onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # DrawerItemProps . onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # DrawerItemProps . onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # DrawerItemProps . onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # DrawerItemProps . onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # DrawerItemProps . onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # DrawerItemProps . onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # DrawerItemProps . onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # DrawerItemProps . onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # DrawerItemProps . onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # DrawerItemProps . onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # DrawerItemProps . onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # DrawerItemProps . onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # DrawerItemProps . onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # DrawerItemProps . onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # DrawerItemProps . onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # DrawerItemProps . onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # DrawerItemProps . onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # DrawerItemProps . onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # DrawerItemProps . onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # DrawerItemProps . onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # DrawerItemProps . onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # DrawerItemProps . onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # DrawerItemProps . onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # DrawerItemProps . onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # DrawerItemProps . onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # DrawerItemProps . onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # DrawerItemProps . onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # DrawerItemProps . onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # DrawerItemProps . onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # DrawerItemProps . onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # DrawerItemProps . onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # DrawerItemProps . onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # DrawerItemProps . onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # DrawerItemProps . onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # DrawerItemProps . onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # DrawerItemProps . onWheelCapture placeholder # \u2022 Optional placeholder : string Inherited from # DrawerItemProps . placeholder prefix # \u2022 Optional prefix : string Inherited from # DrawerItemProps . prefix property # \u2022 Optional property : string Inherited from # DrawerItemProps . property radioGroup # \u2022 Optional radioGroup : string Inherited from # DrawerItemProps . radioGroup renderBoolean # \u2022 Optional renderBoolean : boolean Inherited from # DrawerItemProps . renderBoolean resource # \u2022 Optional resource : string Inherited from # DrawerItemProps . resource results # \u2022 Optional results : number Inherited from # DrawerItemProps . results role # \u2022 Optional role : string Inherited from # DrawerItemProps . role security # \u2022 Optional security : string Inherited from # DrawerItemProps . security slot # \u2022 Optional slot : string Inherited from # DrawerItemProps . slot spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # DrawerItemProps . spellCheck style # \u2022 Optional style : CSSProperties Inherited from # DrawerItemProps . style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # DrawerItemProps . suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # DrawerItemProps . suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # DrawerItemProps . tabIndex title # \u2022 Optional title : string Inherited from # DrawerItemProps . title translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # DrawerItemProps . translate typeof # \u2022 Optional typeof : string Inherited from # DrawerItemProps . typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # DrawerItemProps . unselectable vocab # \u2022 Optional vocab : string Inherited from # DrawerItemProps . vocab","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#interface-draweritemlabelsprops","text":"Renderer . Component .DrawerItemLabelsProps","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#hierarchy","text":"DrawerItemProps \u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#properties","text":"about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType labels labelsOnly lang name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup renderBoolean resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title translate typeof unselectable vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#labels","text":"\u2022 labels : string []","title":"labels"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#renderboolean","text":"\u2022 Optional renderBoolean : boolean","title":"renderBoolean"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.draweritemlabelsprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/","text":"Interface: DrawerItemProps # Renderer . Component .DrawerItemProps Hierarchy # HTMLAttributes \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps Table of contents # Properties # about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType labelsOnly lang name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup renderBoolean resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title translate typeof unselectable vocab Properties # about # \u2022 Optional about : string Inherited from # React.HTMLAttributes.about accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLAttributes.accessKey aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLAttributes.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLAttributes.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLAttributes.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLAttributes.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLAttributes.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLAttributes.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLAttributes.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLAttributes.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLAttributes.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLAttributes.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLAttributes.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLAttributes.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLAttributes.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLAttributes.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLAttributes.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLAttributes.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLAttributes.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLAttributes.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLAttributes.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLAttributes.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLAttributes.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLAttributes.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLAttributes.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLAttributes.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLAttributes.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLAttributes.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLAttributes.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLAttributes.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLAttributes.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLAttributes.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLAttributes.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLAttributes.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLAttributes.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLAttributes.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLAttributes.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLAttributes.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLAttributes.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLAttributes.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLAttributes.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLAttributes.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLAttributes.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLAttributes.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLAttributes.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLAttributes.autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLAttributes.autoSave children # \u2022 Optional children : ReactNode Inherited from # React.HTMLAttributes.children className # \u2022 Optional className : string Overrides # React.HTMLAttributes.className color # \u2022 Optional color : string Inherited from # React.HTMLAttributes.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLAttributes.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLAttributes.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLAttributes.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # React.HTMLAttributes.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLAttributes.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLAttributes.defaultValue dir # \u2022 Optional dir : string Inherited from # React.HTMLAttributes.dir draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLAttributes.draggable hidden # \u2022 Optional hidden : boolean Overrides # React.HTMLAttributes.hidden id # \u2022 Optional id : string Inherited from # React.HTMLAttributes.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLAttributes.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLAttributes.inputMode is # \u2022 Optional is : string 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 Inherited from # React.HTMLAttributes.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLAttributes.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLAttributes.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLAttributes.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLAttributes.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLAttributes.itemType labelsOnly # \u2022 Optional labelsOnly : boolean lang # \u2022 Optional lang : string Inherited from # React.HTMLAttributes.lang name # \u2022 name : ReactNode onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLAttributes.onWheelCapture placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLAttributes.placeholder prefix # \u2022 Optional prefix : string Inherited from # React.HTMLAttributes.prefix property # \u2022 Optional property : string Inherited from # React.HTMLAttributes.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLAttributes.radioGroup renderBoolean # \u2022 Optional renderBoolean : boolean resource # \u2022 Optional resource : string Inherited from # React.HTMLAttributes.resource results # \u2022 Optional results : number Inherited from # React.HTMLAttributes.results role # \u2022 Optional role : string Inherited from # React.HTMLAttributes.role security # \u2022 Optional security : string Inherited from # React.HTMLAttributes.security slot # \u2022 Optional slot : string Inherited from # React.HTMLAttributes.slot spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLAttributes.spellCheck style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLAttributes.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLAttributes.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLAttributes.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLAttributes.tabIndex title # \u2022 Optional title : string Overrides # React.HTMLAttributes.title translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLAttributes.translate typeof # \u2022 Optional typeof : string Inherited from # React.HTMLAttributes.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLAttributes.unselectable vocab # \u2022 Optional vocab : string Inherited from # React.HTMLAttributes.vocab","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#interface-draweritemprops","text":"Renderer . Component .DrawerItemProps","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#hierarchy","text":"HTMLAttributes \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#properties","text":"about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType labelsOnly lang name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup renderBoolean resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title translate typeof unselectable vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#renderboolean","text":"\u2022 Optional renderBoolean : boolean","title":"renderBoolean"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.draweritemprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/","text":"Interface: DrawerParamTogglerProps # Renderer . Component .DrawerParamTogglerProps Table of contents # Properties # label Properties # label # \u2022 label : string | number","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/#interface-drawerparamtogglerprops","text":"Renderer . Component .DrawerParamTogglerProps","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/#properties","text":"label","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawerparamtogglerprops/#label","text":"\u2022 label : string | number","title":"label"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/","text":"Interface: DrawerProps # Renderer . Component .DrawerProps Table of contents # Properties # animation className contentClass onClose open position size title toolbar usePortal Properties # animation # \u2022 Optional animation : string className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 open : boolean position # \u2022 Optional position : \"bottom\" | \"top\" | \"left\" | \"right\" size # \u2022 Optional size : string title # \u2022 title : ReactNode toolbar # \u2022 Optional toolbar : ReactNode usePortal # \u2022 Optional usePortal : boolean","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#interface-drawerprops","text":"Renderer . Component .DrawerProps","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#properties","text":"animation className contentClass onClose open position size title toolbar usePortal","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#animation","text":"\u2022 Optional animation : string","title":"animation"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#open","text":"\u2022 open : boolean","title":"open"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#position","text":"\u2022 Optional position : \"bottom\" | \"top\" | \"left\" | \"right\"","title":"position"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#size","text":"\u2022 Optional size : string","title":"size"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#toolbar","text":"\u2022 Optional toolbar : ReactNode","title":"toolbar"},{"location":"extensions/api/interfaces/renderer.component.drawerprops/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/","text":"Interface: DrawerTitleProps # Renderer . Component .DrawerTitleProps Table of contents # Properties # className title Properties # className # \u2022 Optional className : string title # \u2022 Optional title : ReactNode","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#interface-drawertitleprops","text":"Renderer . Component .DrawerTitleProps","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#properties","text":"className title","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.drawertitleprops/#title","text":"\u2022 Optional title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/","text":"Interface: GroupSelectOption # Renderer . Component .GroupSelectOption Type parameters # Name Type T T : SelectOption = SelectOption Table of contents # Properties # label options Properties # label # \u2022 label : ReactNode options # \u2022 options : T []","title":"Interface: GroupSelectOption"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#interface-groupselectoptiont","text":"Renderer . Component .GroupSelectOption","title":"Interface: GroupSelectOption<T>"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#type-parameters","text":"Name Type T T : SelectOption = SelectOption","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#properties","text":"label options","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#label","text":"\u2022 label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.groupselectoption/#options","text":"\u2022 options : T []","title":"options"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/","text":"Interface: IconDataFnArg # Renderer . Component .IconDataFnArg Table of contents # Properties # isDirty Properties # isDirty # \u2022 isDirty : boolean","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/#interface-icondatafnarg","text":"Renderer . Component .IconDataFnArg","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/#properties","text":"isDirty","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.icondatafnarg/#isdirty","text":"\u2022 isDirty : boolean","title":"isDirty"},{"location":"extensions/api/interfaces/renderer.component.iconprops/","text":"Interface: IconProps # Renderer . Component .IconProps Hierarchy # HTMLAttributes TooltipDecoratorProps \u21b3 IconProps Table of contents # Properties # about accessKey active aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave big children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable focusable hidden href id inlist inputMode interactive is itemID itemProp itemRef itemScope itemType lang link material onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security size slot small smallest spellCheck sticker style suppressContentEditableWarning suppressHydrationWarning svg tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab Properties # about # \u2022 Optional about : string Inherited from # React.HTMLAttributes.about accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLAttributes.accessKey active # \u2022 Optional active : boolean aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLAttributes.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLAttributes.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLAttributes.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLAttributes.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLAttributes.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLAttributes.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLAttributes.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLAttributes.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLAttributes.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLAttributes.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLAttributes.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLAttributes.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLAttributes.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLAttributes.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLAttributes.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLAttributes.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLAttributes.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLAttributes.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLAttributes.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLAttributes.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLAttributes.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLAttributes.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLAttributes.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLAttributes.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLAttributes.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLAttributes.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLAttributes.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLAttributes.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLAttributes.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLAttributes.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLAttributes.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLAttributes.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLAttributes.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLAttributes.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLAttributes.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLAttributes.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLAttributes.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLAttributes.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLAttributes.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLAttributes.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLAttributes.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLAttributes.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLAttributes.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLAttributes.autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLAttributes.autoSave big # \u2022 Optional big : boolean children # \u2022 Optional children : ReactNode Inherited from # React.HTMLAttributes.children className # \u2022 Optional className : string Inherited from # React.HTMLAttributes.className color # \u2022 Optional color : string Inherited from # React.HTMLAttributes.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLAttributes.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLAttributes.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLAttributes.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # React.HTMLAttributes.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLAttributes.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLAttributes.defaultValue dir # \u2022 Optional dir : string Inherited from # React.HTMLAttributes.dir disabled # \u2022 Optional disabled : boolean draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLAttributes.draggable focusable # \u2022 Optional focusable : boolean hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLAttributes.hidden href # \u2022 Optional href : string id # \u2022 Optional id : string Inherited from # React.HTMLAttributes.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLAttributes.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLAttributes.inputMode interactive # \u2022 Optional interactive : boolean is # \u2022 Optional is : string 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 Inherited from # React.HTMLAttributes.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLAttributes.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLAttributes.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLAttributes.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLAttributes.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLAttributes.itemType lang # \u2022 Optional lang : string Inherited from # React.HTMLAttributes.lang link # \u2022 Optional link : LocationDescriptor < Object > material # \u2022 Optional material : string onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLAttributes.onWheelCapture placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLAttributes.placeholder prefix # \u2022 Optional prefix : string Inherited from # React.HTMLAttributes.prefix property # \u2022 Optional property : string Inherited from # React.HTMLAttributes.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLAttributes.radioGroup resource # \u2022 Optional resource : string Inherited from # React.HTMLAttributes.resource results # \u2022 Optional results : number Inherited from # React.HTMLAttributes.results role # \u2022 Optional role : string Inherited from # React.HTMLAttributes.role security # \u2022 Optional security : string Inherited from # React.HTMLAttributes.security size # \u2022 Optional size : string | number slot # \u2022 Optional slot : string Inherited from # React.HTMLAttributes.slot small # \u2022 Optional small : boolean smallest # \u2022 Optional smallest : boolean spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLAttributes.spellCheck sticker # \u2022 Optional sticker : boolean style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLAttributes.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLAttributes.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLAttributes.suppressHydrationWarning svg # \u2022 Optional svg : string tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLAttributes.tabIndex title # \u2022 Optional title : string Inherited from # React.HTMLAttributes.title tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > Inherited from # TooltipDecoratorProps . tooltip tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\" Inherited from # TooltipDecoratorProps . tooltipOverrideDisabled translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLAttributes.translate typeof # \u2022 Optional typeof : string Inherited from # React.HTMLAttributes.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLAttributes.unselectable vocab # \u2022 Optional vocab : string Inherited from # React.HTMLAttributes.vocab","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#interface-iconprops","text":"Renderer . Component .IconProps","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#hierarchy","text":"HTMLAttributes TooltipDecoratorProps \u21b3 IconProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#properties","text":"about accessKey active aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave big children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable focusable hidden href id inlist inputMode interactive is itemID itemProp itemRef itemScope itemType lang link material onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security size slot small smallest spellCheck sticker style suppressContentEditableWarning suppressHydrationWarning svg tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#big","text":"\u2022 Optional big : boolean","title":"big"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#focusable","text":"\u2022 Optional focusable : boolean","title":"focusable"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#interactive","text":"\u2022 Optional interactive : boolean","title":"interactive"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#link","text":"\u2022 Optional link : LocationDescriptor < Object >","title":"link"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#material","text":"\u2022 Optional material : string","title":"material"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#size","text":"\u2022 Optional size : string | number","title":"size"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#smallest","text":"\u2022 Optional smallest : boolean","title":"smallest"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#sticker","text":"\u2022 Optional sticker : boolean","title":"sticker"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#svg","text":"\u2022 Optional svg : string","title":"svg"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.iconprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/","text":"Interface: InputValidator # Renderer . Component .InputValidator Table of contents # Properties # debounce message Methods # condition validate Properties # debounce # \u2022 Optional debounce : number message # \u2022 Optional message : ReactNode | ( value : string , props? : InputProps ) => ReactNode Methods # condition # \u25b8 Optional condition ( props ): boolean Parameters # Name Type props InputProps Returns # boolean validate # \u25b8 validate ( value , props? ): boolean | Promise Parameters # Name Type value string props? InputProps Returns # boolean | Promise ","title":"Interface: InputValidator"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#interface-inputvalidator","text":"Renderer . Component .InputValidator","title":"Interface: InputValidator"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#properties","text":"debounce message","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#methods","text":"condition validate","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#debounce","text":"\u2022 Optional debounce : number","title":"debounce"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#message","text":"\u2022 Optional message : ReactNode | ( value : string , props? : InputProps ) => ReactNode","title":"message"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#condition","text":"\u25b8 Optional condition ( props ): boolean","title":"condition"},{"location":"extensions/api/interfaces/renderer.component.inputvalidator/#validate","text":"\u25b8 validate ( value , props? ): boolean | Promise ","title":"validate"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/","text":"Interface: KubeEventDetailsProps # Renderer . Component .KubeEventDetailsProps Table of contents # Properties # object Properties # object # \u2022 object : KubeObject ","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/#interface-kubeeventdetailsprops","text":"Renderer . Component .KubeEventDetailsProps","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/#properties","text":"object","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeeventdetailsprops/#object","text":"\u2022 object : KubeObject ","title":"object"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/","text":"Interface: KubeObjectDetailsProps # Renderer . Component .KubeObjectDetailsProps Type parameters # Name Type T T : KubeObject = KubeObject Table of contents # Properties # className object Properties # className # \u2022 Optional className : string object # \u2022 object : T","title":"Interface: KubeObjectDetailsProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#interface-kubeobjectdetailspropst","text":"Renderer . Component .KubeObjectDetailsProps","title":"Interface: KubeObjectDetailsProps<T>"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#type-parameters","text":"Name Type T T : KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#properties","text":"className object","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/#object","text":"\u2022 object : T","title":"object"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/","text":"Interface: KubeObjectListLayoutProps # Renderer . Component .KubeObjectListLayoutProps Type parameters # Name Type K K : KubeObject Hierarchy # ItemListLayoutProps \u21b3 KubeObjectListLayoutProps Table of contents # Properties # addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps dependentStores detailsItem filterCallbacks filterItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails preloadStores renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader searchFilters showHeader sortingCallbacks store tableId tableProps virtual Properties # addRemoveButtons # \u2022 Optional addRemoveButtons : Partial Inherited from # ItemListLayoutProps.addRemoveButtons className # \u2022 className : IClassName Inherited from # ItemListLayoutProps.className copyClassNameFromHeadCells # \u2022 Optional copyClassNameFromHeadCells : boolean Inherited from # ItemListLayoutProps.copyClassNameFromHeadCells customizeHeader # \u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer [] Inherited from # ItemListLayoutProps.customizeHeader customizeRemoveDialog # \u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams > Type declaration # \u25b8 ( selectedItems ): Partial < ConfirmDialogParams > Parameters # Name Type selectedItems K [] Returns # Partial < ConfirmDialogParams > Inherited from # ItemListLayoutProps.customizeRemoveDialog customizeTableRowProps # \u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps > Type declaration # \u25b8 ( item ): Partial < TableRowProps > Parameters # Name Type item K Returns # Partial < TableRowProps > Inherited from # ItemListLayoutProps.customizeTableRowProps dependentStores # \u2022 Optional dependentStores : KubeObjectStore < KubeObject >[] Overrides # ItemListLayoutProps.dependentStores detailsItem # \u2022 Optional detailsItem : K Inherited from # ItemListLayoutProps.detailsItem filterCallbacks # \u2022 Optional filterCallbacks : ItemsFilters Inherited from # ItemListLayoutProps.filterCallbacks filterItems # \u2022 Optional filterItems : ItemsFilter [] deprecated Inherited from # ItemListLayoutProps.filterItems hasDetailsView # \u2022 Optional hasDetailsView : boolean Inherited from # ItemListLayoutProps.hasDetailsView headerClassName # \u2022 Optional headerClassName : IClassName Inherited from # ItemListLayoutProps.headerClassName hideFilters # \u2022 Optional hideFilters : boolean Inherited from # ItemListLayoutProps.hideFilters isConfigurable # \u2022 Optional isConfigurable : boolean Inherited from # ItemListLayoutProps.isConfigurable isReady # \u2022 Optional isReady : boolean Inherited from # ItemListLayoutProps.isReady isSelectable # \u2022 Optional isSelectable : boolean Inherited from # ItemListLayoutProps.isSelectable items # \u2022 Optional items : K [] Inherited from # ItemListLayoutProps.items onDetails # \u2022 Optional onDetails : ( item : K ) => void Type declaration # \u25b8 ( item ): void Parameters # Name Type item K Returns # void Inherited from # ItemListLayoutProps.onDetails preloadStores # \u2022 Optional preloadStores : boolean Inherited from # ItemListLayoutProps.preloadStores renderFooter # \u2022 Optional renderFooter : ( parent : ItemListLayout ) => ReactNode Type declaration # \u25b8 ( parent ): ReactNode Parameters # Name Type parent ItemListLayout Returns # ReactNode Inherited from # ItemListLayoutProps.renderFooter renderHeaderTitle # \u2022 Optional renderHeaderTitle : ReactNode | ( parent : ItemListLayout ) => ReactNode Inherited from # ItemListLayoutProps.renderHeaderTitle renderItemMenu # \u2022 Optional renderItemMenu : ( item : K , store : ItemStore ) => ReactNode Type declaration # \u25b8 ( item , store ): ReactNode Parameters # Name Type item K store ItemStore Returns # ReactNode Inherited from # ItemListLayoutProps.renderItemMenu renderTableContents # \u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[] Type declaration # \u25b8 ( item ): ( ReactNode | TableCellProps )[] Parameters # Name Type item K Returns # ( ReactNode | TableCellProps )[] Inherited from # ItemListLayoutProps.renderTableContents renderTableHeader # \u2022 renderTableHeader : TableCellProps [] Inherited from # ItemListLayoutProps.renderTableHeader searchFilters # \u2022 Optional searchFilters : SearchFilter [] Inherited from # ItemListLayoutProps.searchFilters showHeader # \u2022 Optional showHeader : boolean Inherited from # ItemListLayoutProps.showHeader sortingCallbacks # \u2022 Optional sortingCallbacks : TableSortCallbacks Inherited from # ItemListLayoutProps.sortingCallbacks store # \u2022 store : KubeObjectStore Overrides # ItemListLayoutProps.store tableId # \u2022 Optional tableId : string Inherited from # ItemListLayoutProps.tableId tableProps # \u2022 Optional tableProps : Partial < TableProps > Inherited from # ItemListLayoutProps.tableProps virtual # \u2022 Optional virtual : boolean Inherited from # ItemListLayoutProps.virtual","title":"Interface: KubeObjectListLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#interface-kubeobjectlistlayoutpropsk","text":"Renderer . Component .KubeObjectListLayoutProps","title":"Interface: KubeObjectListLayoutProps<K>"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#type-parameters","text":"Name Type K K : KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#hierarchy","text":"ItemListLayoutProps \u21b3 KubeObjectListLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#properties","text":"addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps dependentStores detailsItem filterCallbacks filterItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails preloadStores renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader searchFilters showHeader sortingCallbacks store tableId tableProps virtual","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#addremovebuttons","text":"\u2022 Optional addRemoveButtons : Partial ","title":"addRemoveButtons"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#classname","text":"\u2022 className : IClassName","title":"className"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#copyclassnamefromheadcells","text":"\u2022 Optional copyClassNameFromHeadCells : boolean","title":"copyClassNameFromHeadCells"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#customizeheader","text":"\u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer []","title":"customizeHeader"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#customizeremovedialog","text":"\u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams >","title":"customizeRemoveDialog"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#customizetablerowprops","text":"\u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps >","title":"customizeTableRowProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#dependentstores","text":"\u2022 Optional dependentStores : KubeObjectStore < KubeObject >[]","title":"dependentStores"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#detailsitem","text":"\u2022 Optional detailsItem : K","title":"detailsItem"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#filtercallbacks","text":"\u2022 Optional filterCallbacks : ItemsFilters ","title":"filterCallbacks"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#filteritems","text":"\u2022 Optional filterItems : ItemsFilter [] deprecated","title":"filterItems"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#hasdetailsview","text":"\u2022 Optional hasDetailsView : boolean","title":"hasDetailsView"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#headerclassname","text":"\u2022 Optional headerClassName : IClassName","title":"headerClassName"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#hidefilters","text":"\u2022 Optional hideFilters : boolean","title":"hideFilters"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#isconfigurable","text":"\u2022 Optional isConfigurable : boolean","title":"isConfigurable"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#isready","text":"\u2022 Optional isReady : boolean","title":"isReady"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#isselectable","text":"\u2022 Optional isSelectable : boolean","title":"isSelectable"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#items","text":"\u2022 Optional items : K []","title":"items"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#ondetails","text":"\u2022 Optional onDetails : ( item : K ) => void","title":"onDetails"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#preloadstores","text":"\u2022 Optional preloadStores : boolean","title":"preloadStores"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#renderfooter","text":"\u2022 Optional renderFooter : ( parent : ItemListLayout ) => ReactNode","title":"renderFooter"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#renderheadertitle","text":"\u2022 Optional renderHeaderTitle : ReactNode | ( parent : ItemListLayout ) => ReactNode","title":"renderHeaderTitle"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#renderitemmenu","text":"\u2022 Optional renderItemMenu : ( item : K , store : ItemStore ) => ReactNode","title":"renderItemMenu"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#rendertablecontents","text":"\u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[]","title":"renderTableContents"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#rendertableheader","text":"\u2022 renderTableHeader : TableCellProps []","title":"renderTableHeader"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#searchfilters","text":"\u2022 Optional searchFilters : SearchFilter []","title":"searchFilters"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#showheader","text":"\u2022 Optional showHeader : boolean","title":"showHeader"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#sortingcallbacks","text":"\u2022 Optional sortingCallbacks : TableSortCallbacks ","title":"sortingCallbacks"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#store","text":"\u2022 store : KubeObjectStore ","title":"store"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#tableprops","text":"\u2022 Optional tableProps : Partial < TableProps >","title":"tableProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/#virtual","text":"\u2022 Optional virtual : boolean","title":"virtual"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/","text":"Interface: KubeObjectMenuProps # Renderer . Component .KubeObjectMenuProps Type parameters # Name T Hierarchy # MenuActionsProps \u21b3 KubeObjectMenuProps Table of contents # Properties # autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll editable htmlFor id isOpen object position removable removeConfirmationMessage toggleEvent toolbar triggerIcon usePortal Methods # close onOpen open removeAction updateAction Properties # autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean Inherited from # MenuActionsProps . autoCloseOnSelect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # MenuActionsProps . autoFocus children # \u2022 Optional children : ReactNode Inherited from # MenuActionsProps . children className # \u2022 Optional className : string Inherited from # MenuActionsProps . className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # MenuActionsProps . closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # MenuActionsProps . closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # MenuActionsProps . closeOnScroll editable # \u2022 Optional editable : boolean htmlFor # \u2022 Optional htmlFor : string Inherited from # MenuActionsProps . htmlFor id # \u2022 Optional id : string Inherited from # MenuActionsProps . id isOpen # \u2022 Optional isOpen : boolean Inherited from # MenuActionsProps . isOpen object # \u2022 object : T position # \u2022 Optional position : MenuPosition Inherited from # MenuActionsProps . position removable # \u2022 Optional removable : boolean removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Inherited from # MenuActionsProps . removeConfirmationMessage toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # MenuActionsProps . toggleEvent toolbar # \u2022 Optional toolbar : boolean Inherited from # MenuActionsProps . toolbar triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps Inherited from # MenuActionsProps . triggerIcon usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # MenuActionsProps . usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # MenuActionsProps . close onOpen # \u25b8 Optional onOpen (): void Returns # void Inherited from # MenuActionsProps . onOpen open # \u25b8 Optional open (): void Returns # void Inherited from # MenuActionsProps . open removeAction # \u25b8 Optional removeAction (): void Returns # void Inherited from # MenuActionsProps . removeAction updateAction # \u25b8 Optional updateAction (): void Returns # void Inherited from # MenuActionsProps . updateAction","title":"Interface: KubeObjectMenuProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#interface-kubeobjectmenupropst","text":"Renderer . Component .KubeObjectMenuProps","title":"Interface: KubeObjectMenuProps<T>"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#hierarchy","text":"MenuActionsProps \u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#properties","text":"autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll editable htmlFor id isOpen object position removable removeConfirmationMessage toggleEvent toolbar triggerIcon usePortal","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#methods","text":"close onOpen open removeAction updateAction","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#editable","text":"\u2022 Optional editable : boolean","title":"editable"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#object","text":"\u2022 object : T","title":"object"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#removable","text":"\u2022 Optional removable : boolean","title":"removable"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#onopen","text":"\u25b8 Optional onOpen (): void","title":"onOpen"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#removeaction","text":"\u25b8 Optional removeAction (): void","title":"removeAction"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmenuprops/#updateaction","text":"\u25b8 Optional updateAction (): void","title":"updateAction"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/","text":"Interface: KubeObjectMetaProps # Renderer . Component .KubeObjectMetaProps Table of contents # Properties # hideFields object Properties # hideFields # \u2022 Optional hideFields : keyof KubeObjectMetadata [] object # \u2022 object : KubeObject ","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#interface-kubeobjectmetaprops","text":"Renderer . Component .KubeObjectMetaProps","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#properties","text":"hideFields object","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#hidefields","text":"\u2022 Optional hideFields : keyof KubeObjectMetadata []","title":"hideFields"},{"location":"extensions/api/interfaces/renderer.component.kubeobjectmetaprops/#object","text":"\u2022 object : KubeObject ","title":"object"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/","text":"Interface: LineProgressProps # Renderer . Component .LineProgressProps Hierarchy # HTMLProps TooltipDecoratorProps \u21b3 LineProgressProps Table of contents # Properties # about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster precise prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title tooltip tooltipOverrideDisabled translate type typeof unselectable useMap value vocab width wmode wrap Properties # about # \u2022 Optional about : string Inherited from # React.HTMLProps.about accept # \u2022 Optional accept : string Inherited from # React.HTMLProps.accept acceptCharset # \u2022 Optional acceptCharset : string Inherited from # React.HTMLProps.acceptCharset accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLProps.accessKey action # \u2022 Optional action : string Inherited from # React.HTMLProps.action allowFullScreen # \u2022 Optional allowFullScreen : boolean Inherited from # React.HTMLProps.allowFullScreen allowTransparency # \u2022 Optional allowTransparency : boolean Inherited from # React.HTMLProps.allowTransparency alt # \u2022 Optional alt : string Inherited from # React.HTMLProps.alt aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLProps.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLProps.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLProps.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLProps.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLProps.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLProps.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLProps.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLProps.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLProps.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLProps.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLProps.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLProps.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLProps.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLProps.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLProps.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLProps.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLProps.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLProps.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLProps.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLProps.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLProps.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLProps.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLProps.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLProps.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLProps.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLProps.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLProps.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLProps.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLProps.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLProps.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLProps.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLProps.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLProps.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLProps.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLProps.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLProps.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLProps.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLProps.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLProps.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLProps.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLProps.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLProps.aria-valuetext as # \u2022 Optional as : string Inherited from # React.HTMLProps.as async # \u2022 Optional async : boolean Inherited from # React.HTMLProps.async autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLProps.autoCapitalize autoComplete # \u2022 Optional autoComplete : string Inherited from # React.HTMLProps.autoComplete autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLProps.autoCorrect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # React.HTMLProps.autoFocus autoPlay # \u2022 Optional autoPlay : boolean Inherited from # React.HTMLProps.autoPlay autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLProps.autoSave capture # \u2022 Optional capture : string | boolean Inherited from # React.HTMLProps.capture cellPadding # \u2022 Optional cellPadding : string | number Inherited from # React.HTMLProps.cellPadding cellSpacing # \u2022 Optional cellSpacing : string | number Inherited from # React.HTMLProps.cellSpacing challenge # \u2022 Optional challenge : string Inherited from # React.HTMLProps.challenge charSet # \u2022 Optional charSet : string Inherited from # React.HTMLProps.charSet checked # \u2022 Optional checked : boolean Inherited from # React.HTMLProps.checked children # \u2022 Optional children : ReactNode Inherited from # React.HTMLProps.children cite # \u2022 Optional cite : string Inherited from # React.HTMLProps.cite classID # \u2022 Optional classID : string Inherited from # React.HTMLProps.classID className # \u2022 Optional className : any Overrides # React.HTMLProps.className colSpan # \u2022 Optional colSpan : number Inherited from # React.HTMLProps.colSpan color # \u2022 Optional color : string Inherited from # React.HTMLProps.color cols # \u2022 Optional cols : number Inherited from # React.HTMLProps.cols content # \u2022 Optional content : string Inherited from # React.HTMLProps.content contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLProps.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLProps.contextMenu controls # \u2022 Optional controls : boolean Inherited from # React.HTMLProps.controls coords # \u2022 Optional coords : string Inherited from # React.HTMLProps.coords crossOrigin # \u2022 Optional crossOrigin : string Inherited from # React.HTMLProps.crossOrigin dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLProps.dangerouslySetInnerHTML data # \u2022 Optional data : string Inherited from # React.HTMLProps.data datatype # \u2022 Optional datatype : string Inherited from # React.HTMLProps.datatype dateTime # \u2022 Optional dateTime : string Inherited from # React.HTMLProps.dateTime default # \u2022 Optional default : boolean Inherited from # React.HTMLProps.default defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLProps.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLProps.defaultValue defer # \u2022 Optional defer : boolean Inherited from # React.HTMLProps.defer dir # \u2022 Optional dir : string Inherited from # React.HTMLProps.dir disabled # \u2022 Optional disabled : boolean Inherited from # React.HTMLProps.disabled download # \u2022 Optional download : any Inherited from # React.HTMLProps.download draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLProps.draggable encType # \u2022 Optional encType : string Inherited from # React.HTMLProps.encType form # \u2022 Optional form : string Inherited from # React.HTMLProps.form formAction # \u2022 Optional formAction : string Inherited from # React.HTMLProps.formAction formEncType # \u2022 Optional formEncType : string Inherited from # React.HTMLProps.formEncType formMethod # \u2022 Optional formMethod : string Inherited from # React.HTMLProps.formMethod formNoValidate # \u2022 Optional formNoValidate : boolean Inherited from # React.HTMLProps.formNoValidate formTarget # \u2022 Optional formTarget : string Inherited from # React.HTMLProps.formTarget frameBorder # \u2022 Optional frameBorder : string | number Inherited from # React.HTMLProps.frameBorder headers # \u2022 Optional headers : string Inherited from # React.HTMLProps.headers height # \u2022 Optional height : string | number Inherited from # React.HTMLProps.height hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLProps.hidden high # \u2022 Optional high : number Inherited from # React.HTMLProps.high href # \u2022 Optional href : string Inherited from # React.HTMLProps.href hrefLang # \u2022 Optional hrefLang : string Inherited from # React.HTMLProps.hrefLang htmlFor # \u2022 Optional htmlFor : string Inherited from # React.HTMLProps.htmlFor httpEquiv # \u2022 Optional httpEquiv : string Inherited from # React.HTMLProps.httpEquiv id # \u2022 Optional id : string Inherited from # React.HTMLProps.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLProps.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLProps.inputMode integrity # \u2022 Optional integrity : string Inherited from # React.HTMLProps.integrity is # \u2022 Optional is : string 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 Inherited from # React.HTMLProps.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLProps.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLProps.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLProps.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLProps.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLProps.itemType key # \u2022 Optional key : Key Inherited from # React.HTMLProps.key keyParams # \u2022 Optional keyParams : string Inherited from # React.HTMLProps.keyParams keyType # \u2022 Optional keyType : string Inherited from # React.HTMLProps.keyType kind # \u2022 Optional kind : string Inherited from # React.HTMLProps.kind label # \u2022 Optional label : string Inherited from # React.HTMLProps.label lang # \u2022 Optional lang : string Inherited from # React.HTMLProps.lang list # \u2022 Optional list : string Inherited from # React.HTMLProps.list loop # \u2022 Optional loop : boolean Inherited from # React.HTMLProps.loop low # \u2022 Optional low : number Inherited from # React.HTMLProps.low manifest # \u2022 Optional manifest : string Inherited from # React.HTMLProps.manifest marginHeight # \u2022 Optional marginHeight : number Inherited from # React.HTMLProps.marginHeight marginWidth # \u2022 Optional marginWidth : number Inherited from # React.HTMLProps.marginWidth max # \u2022 Optional max : number Overrides # React.HTMLProps.max maxLength # \u2022 Optional maxLength : number Inherited from # React.HTMLProps.maxLength media # \u2022 Optional media : string Inherited from # React.HTMLProps.media mediaGroup # \u2022 Optional mediaGroup : string Inherited from # React.HTMLProps.mediaGroup method # \u2022 Optional method : string Inherited from # React.HTMLProps.method min # \u2022 Optional min : number Overrides # React.HTMLProps.min minLength # \u2022 Optional minLength : number Inherited from # React.HTMLProps.minLength multiple # \u2022 Optional multiple : boolean Inherited from # React.HTMLProps.multiple muted # \u2022 Optional muted : boolean Inherited from # React.HTMLProps.muted name # \u2022 Optional name : string Inherited from # React.HTMLProps.name noValidate # \u2022 Optional noValidate : boolean Inherited from # React.HTMLProps.noValidate nonce # \u2022 Optional nonce : string Inherited from # React.HTMLProps.nonce onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLProps.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLProps.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLProps.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLProps.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLProps.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLProps.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLProps.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLProps.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLProps.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLProps.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLProps.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLProps.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLProps.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLProps.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLProps.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLProps.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLProps.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLProps.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLProps.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLProps.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLProps.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLProps.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLProps.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLProps.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLProps.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLProps.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLProps.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLProps.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLProps.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLProps.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLProps.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLProps.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLProps.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLProps.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLProps.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLProps.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLProps.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLProps.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLProps.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLProps.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLProps.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLProps.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLProps.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLProps.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLProps.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLProps.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLProps.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLProps.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLProps.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLProps.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLProps.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLProps.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLProps.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLProps.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLProps.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLProps.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLProps.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLProps.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLProps.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLProps.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLProps.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLProps.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLProps.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLProps.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLProps.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLProps.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLProps.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLProps.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLProps.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLProps.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLProps.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLProps.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLProps.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLProps.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLProps.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLProps.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLProps.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLProps.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLProps.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLProps.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLProps.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLProps.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLProps.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLProps.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLProps.onWheelCapture open # \u2022 Optional open : boolean Inherited from # React.HTMLProps.open optimum # \u2022 Optional optimum : number Inherited from # React.HTMLProps.optimum pattern # \u2022 Optional pattern : string Inherited from # React.HTMLProps.pattern placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLProps.placeholder playsInline # \u2022 Optional playsInline : boolean Inherited from # React.HTMLProps.playsInline poster # \u2022 Optional poster : string Inherited from # React.HTMLProps.poster precise # \u2022 Optional precise : number prefix # \u2022 Optional prefix : string Inherited from # React.HTMLProps.prefix preload # \u2022 Optional preload : string Inherited from # React.HTMLProps.preload property # \u2022 Optional property : string Inherited from # React.HTMLProps.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLProps.radioGroup readOnly # \u2022 Optional readOnly : boolean Inherited from # React.HTMLProps.readOnly ref # \u2022 Optional ref : LegacyRef Inherited from # React.HTMLProps.ref rel # \u2022 Optional rel : string Inherited from # React.HTMLProps.rel required # \u2022 Optional required : boolean Inherited from # React.HTMLProps.required resource # \u2022 Optional resource : string Inherited from # React.HTMLProps.resource results # \u2022 Optional results : number Inherited from # React.HTMLProps.results reversed # \u2022 Optional reversed : boolean Inherited from # React.HTMLProps.reversed role # \u2022 Optional role : string Inherited from # React.HTMLProps.role rowSpan # \u2022 Optional rowSpan : number Inherited from # React.HTMLProps.rowSpan rows # \u2022 Optional rows : number Inherited from # React.HTMLProps.rows sandbox # \u2022 Optional sandbox : string Inherited from # React.HTMLProps.sandbox scope # \u2022 Optional scope : string Inherited from # React.HTMLProps.scope scoped # \u2022 Optional scoped : boolean Inherited from # React.HTMLProps.scoped scrolling # \u2022 Optional scrolling : string Inherited from # React.HTMLProps.scrolling seamless # \u2022 Optional seamless : boolean Inherited from # React.HTMLProps.seamless security # \u2022 Optional security : string Inherited from # React.HTMLProps.security selected # \u2022 Optional selected : boolean Inherited from # React.HTMLProps.selected shape # \u2022 Optional shape : string Inherited from # React.HTMLProps.shape size # \u2022 Optional size : number Inherited from # React.HTMLProps.size sizes # \u2022 Optional sizes : string Inherited from # React.HTMLProps.sizes slot # \u2022 Optional slot : string Inherited from # React.HTMLProps.slot span # \u2022 Optional span : number Inherited from # React.HTMLProps.span spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLProps.spellCheck src # \u2022 Optional src : string Inherited from # React.HTMLProps.src srcDoc # \u2022 Optional srcDoc : string Inherited from # React.HTMLProps.srcDoc srcLang # \u2022 Optional srcLang : string Inherited from # React.HTMLProps.srcLang srcSet # \u2022 Optional srcSet : string Inherited from # React.HTMLProps.srcSet start # \u2022 Optional start : number Inherited from # React.HTMLProps.start step # \u2022 Optional step : string | number Inherited from # React.HTMLProps.step style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLProps.style summary # \u2022 Optional summary : string Inherited from # React.HTMLProps.summary suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLProps.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLProps.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLProps.tabIndex target # \u2022 Optional target : string Inherited from # React.HTMLProps.target title # \u2022 Optional title : string Inherited from # React.HTMLProps.title tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > Inherited from # TooltipDecoratorProps . tooltip tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\" Inherited from # TooltipDecoratorProps . tooltipOverrideDisabled translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLProps.translate type # \u2022 Optional type : string Inherited from # React.HTMLProps.type typeof # \u2022 Optional typeof : string Inherited from # React.HTMLProps.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLProps.unselectable useMap # \u2022 Optional useMap : string Inherited from # React.HTMLProps.useMap value # \u2022 value : number Overrides # React.HTMLProps.value vocab # \u2022 Optional vocab : string Inherited from # React.HTMLProps.vocab width # \u2022 Optional width : string | number Inherited from # React.HTMLProps.width wmode # \u2022 Optional wmode : string Inherited from # React.HTMLProps.wmode wrap # \u2022 Optional wrap : string Inherited from # React.HTMLProps.wrap","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#interface-lineprogressprops","text":"Renderer . Component .LineProgressProps","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#hierarchy","text":"HTMLProps TooltipDecoratorProps \u21b3 LineProgressProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#properties","text":"about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster precise prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title tooltip tooltipOverrideDisabled translate type typeof unselectable useMap value vocab width wmode wrap","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#accept","text":"\u2022 Optional accept : string","title":"accept"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#acceptcharset","text":"\u2022 Optional acceptCharset : string","title":"acceptCharset"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#allowfullscreen","text":"\u2022 Optional allowFullScreen : boolean","title":"allowFullScreen"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#allowtransparency","text":"\u2022 Optional allowTransparency : boolean","title":"allowTransparency"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#alt","text":"\u2022 Optional alt : string","title":"alt"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#as","text":"\u2022 Optional as : string","title":"as"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#async","text":"\u2022 Optional async : boolean","title":"async"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autocomplete","text":"\u2022 Optional autoComplete : string","title":"autoComplete"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autoplay","text":"\u2022 Optional autoPlay : boolean","title":"autoPlay"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#capture","text":"\u2022 Optional capture : string | boolean","title":"capture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#cellpadding","text":"\u2022 Optional cellPadding : string | number","title":"cellPadding"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#cellspacing","text":"\u2022 Optional cellSpacing : string | number","title":"cellSpacing"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#challenge","text":"\u2022 Optional challenge : string","title":"challenge"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#charset","text":"\u2022 Optional charSet : string","title":"charSet"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#cite","text":"\u2022 Optional cite : string","title":"cite"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#classid","text":"\u2022 Optional classID : string","title":"classID"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#classname","text":"\u2022 Optional className : any","title":"className"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#colspan","text":"\u2022 Optional colSpan : number","title":"colSpan"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#cols","text":"\u2022 Optional cols : number","title":"cols"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#content","text":"\u2022 Optional content : string","title":"content"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#controls","text":"\u2022 Optional controls : boolean","title":"controls"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#coords","text":"\u2022 Optional coords : string","title":"coords"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#crossorigin","text":"\u2022 Optional crossOrigin : string","title":"crossOrigin"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#data","text":"\u2022 Optional data : string","title":"data"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#datetime","text":"\u2022 Optional dateTime : string","title":"dateTime"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#defer","text":"\u2022 Optional defer : boolean","title":"defer"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#download","text":"\u2022 Optional download : any","title":"download"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#enctype","text":"\u2022 Optional encType : string","title":"encType"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#form","text":"\u2022 Optional form : string","title":"form"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#formaction","text":"\u2022 Optional formAction : string","title":"formAction"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#formenctype","text":"\u2022 Optional formEncType : string","title":"formEncType"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#formmethod","text":"\u2022 Optional formMethod : string","title":"formMethod"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#formnovalidate","text":"\u2022 Optional formNoValidate : boolean","title":"formNoValidate"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#formtarget","text":"\u2022 Optional formTarget : string","title":"formTarget"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#frameborder","text":"\u2022 Optional frameBorder : string | number","title":"frameBorder"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#headers","text":"\u2022 Optional headers : string","title":"headers"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#high","text":"\u2022 Optional high : number","title":"high"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#hreflang","text":"\u2022 Optional hrefLang : string","title":"hrefLang"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#httpequiv","text":"\u2022 Optional httpEquiv : string","title":"httpEquiv"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#integrity","text":"\u2022 Optional integrity : string","title":"integrity"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#key","text":"\u2022 Optional key : Key","title":"key"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#keyparams","text":"\u2022 Optional keyParams : string","title":"keyParams"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#keytype","text":"\u2022 Optional keyType : string","title":"keyType"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#kind","text":"\u2022 Optional kind : string","title":"kind"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#label","text":"\u2022 Optional label : string","title":"label"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#list","text":"\u2022 Optional list : string","title":"list"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#loop","text":"\u2022 Optional loop : boolean","title":"loop"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#low","text":"\u2022 Optional low : number","title":"low"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#manifest","text":"\u2022 Optional manifest : string","title":"manifest"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#marginheight","text":"\u2022 Optional marginHeight : number","title":"marginHeight"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#marginwidth","text":"\u2022 Optional marginWidth : number","title":"marginWidth"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#max","text":"\u2022 Optional max : number","title":"max"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#maxlength","text":"\u2022 Optional maxLength : number","title":"maxLength"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#media","text":"\u2022 Optional media : string","title":"media"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#mediagroup","text":"\u2022 Optional mediaGroup : string","title":"mediaGroup"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#method","text":"\u2022 Optional method : string","title":"method"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#min","text":"\u2022 Optional min : number","title":"min"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#minlength","text":"\u2022 Optional minLength : number","title":"minLength"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#multiple","text":"\u2022 Optional multiple : boolean","title":"multiple"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#muted","text":"\u2022 Optional muted : boolean","title":"muted"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#nonce","text":"\u2022 Optional nonce : string","title":"nonce"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#open","text":"\u2022 Optional open : boolean","title":"open"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#optimum","text":"\u2022 Optional optimum : number","title":"optimum"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#pattern","text":"\u2022 Optional pattern : string","title":"pattern"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#playsinline","text":"\u2022 Optional playsInline : boolean","title":"playsInline"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#poster","text":"\u2022 Optional poster : string","title":"poster"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#precise","text":"\u2022 Optional precise : number","title":"precise"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#preload","text":"\u2022 Optional preload : string","title":"preload"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#ref","text":"\u2022 Optional ref : LegacyRef ","title":"ref"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#rel","text":"\u2022 Optional rel : string","title":"rel"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#required","text":"\u2022 Optional required : boolean","title":"required"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#reversed","text":"\u2022 Optional reversed : boolean","title":"reversed"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#rowspan","text":"\u2022 Optional rowSpan : number","title":"rowSpan"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#rows","text":"\u2022 Optional rows : number","title":"rows"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#sandbox","text":"\u2022 Optional sandbox : string","title":"sandbox"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#scope","text":"\u2022 Optional scope : string","title":"scope"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#scoped","text":"\u2022 Optional scoped : boolean","title":"scoped"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#scrolling","text":"\u2022 Optional scrolling : string","title":"scrolling"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#seamless","text":"\u2022 Optional seamless : boolean","title":"seamless"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#shape","text":"\u2022 Optional shape : string","title":"shape"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#size","text":"\u2022 Optional size : number","title":"size"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#sizes","text":"\u2022 Optional sizes : string","title":"sizes"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#span","text":"\u2022 Optional span : number","title":"span"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#src","text":"\u2022 Optional src : string","title":"src"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#srcdoc","text":"\u2022 Optional srcDoc : string","title":"srcDoc"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#srclang","text":"\u2022 Optional srcLang : string","title":"srcLang"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#srcset","text":"\u2022 Optional srcSet : string","title":"srcSet"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#start","text":"\u2022 Optional start : number","title":"start"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#step","text":"\u2022 Optional step : string | number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#summary","text":"\u2022 Optional summary : string","title":"summary"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#target","text":"\u2022 Optional target : string","title":"target"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#usemap","text":"\u2022 Optional useMap : string","title":"useMap"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#value","text":"\u2022 value : number","title":"value"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#wmode","text":"\u2022 Optional wmode : string","title":"wmode"},{"location":"extensions/api/interfaces/renderer.component.lineprogressprops/#wrap","text":"\u2022 Optional wrap : string","title":"wrap"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/","text":"Interface: MenuActionsProps # Renderer . Component .MenuActionsProps Hierarchy # Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps Table of contents # Properties # autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll htmlFor id isOpen position removeConfirmationMessage toggleEvent toolbar triggerIcon usePortal Methods # close onOpen open removeAction updateAction Properties # autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean autoFocus # \u2022 Optional autoFocus : boolean Inherited from # Partial.autoFocus children # \u2022 Optional children : ReactNode Inherited from # Partial.children className # \u2022 Optional className : string Overrides # Partial.className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # Partial.closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # Partial.closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # Partial.closeOnScroll htmlFor # \u2022 Optional htmlFor : string Inherited from # Partial.htmlFor id # \u2022 Optional id : string Inherited from # Partial.id isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen position # \u2022 Optional position : MenuPosition Inherited from # Partial.position removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # Partial.toggleEvent toolbar # \u2022 Optional toolbar : boolean triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # Partial.usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # Partial.close onOpen # \u25b8 Optional onOpen (): void Returns # void open # \u25b8 Optional open (): void Returns # void Inherited from # Partial.open removeAction # \u25b8 Optional removeAction (): void Returns # void updateAction # \u25b8 Optional updateAction (): void Returns # void","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#interface-menuactionsprops","text":"Renderer . Component .MenuActionsProps","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#hierarchy","text":"Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#properties","text":"autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll htmlFor id isOpen position removeConfirmationMessage toggleEvent toolbar triggerIcon usePortal","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#methods","text":"close onOpen open removeAction updateAction","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#onopen","text":"\u25b8 Optional onOpen (): void","title":"onOpen"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#removeaction","text":"\u25b8 Optional removeAction (): void","title":"removeAction"},{"location":"extensions/api/interfaces/renderer.component.menuactionsprops/#updateaction","text":"\u25b8 Optional updateAction (): void","title":"updateAction"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/","text":"Interface: MenuItemProps # Renderer . Component .MenuItemProps Hierarchy # HTMLProps \u21b3 MenuItemProps Table of contents # Properties # about accept acceptCharset accessKey action active allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv icon id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot spacer span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap Properties # about # \u2022 Optional about : string Inherited from # React.HTMLProps.about accept # \u2022 Optional accept : string Inherited from # React.HTMLProps.accept acceptCharset # \u2022 Optional acceptCharset : string Inherited from # React.HTMLProps.acceptCharset accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLProps.accessKey action # \u2022 Optional action : string Inherited from # React.HTMLProps.action active # \u2022 Optional active : boolean allowFullScreen # \u2022 Optional allowFullScreen : boolean Inherited from # React.HTMLProps.allowFullScreen allowTransparency # \u2022 Optional allowTransparency : boolean Inherited from # React.HTMLProps.allowTransparency alt # \u2022 Optional alt : string Inherited from # React.HTMLProps.alt aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLProps.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLProps.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLProps.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLProps.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLProps.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLProps.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLProps.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLProps.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLProps.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLProps.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLProps.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLProps.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLProps.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLProps.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLProps.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLProps.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLProps.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLProps.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLProps.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLProps.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLProps.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLProps.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLProps.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLProps.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLProps.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLProps.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLProps.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLProps.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLProps.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLProps.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLProps.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLProps.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLProps.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLProps.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLProps.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLProps.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLProps.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLProps.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLProps.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLProps.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLProps.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLProps.aria-valuetext as # \u2022 Optional as : string Inherited from # React.HTMLProps.as async # \u2022 Optional async : boolean Inherited from # React.HTMLProps.async autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLProps.autoCapitalize autoComplete # \u2022 Optional autoComplete : string Inherited from # React.HTMLProps.autoComplete autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLProps.autoCorrect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # React.HTMLProps.autoFocus autoPlay # \u2022 Optional autoPlay : boolean Inherited from # React.HTMLProps.autoPlay autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLProps.autoSave capture # \u2022 Optional capture : string | boolean Inherited from # React.HTMLProps.capture cellPadding # \u2022 Optional cellPadding : string | number Inherited from # React.HTMLProps.cellPadding cellSpacing # \u2022 Optional cellSpacing : string | number Inherited from # React.HTMLProps.cellSpacing challenge # \u2022 Optional challenge : string Inherited from # React.HTMLProps.challenge charSet # \u2022 Optional charSet : string Inherited from # React.HTMLProps.charSet checked # \u2022 Optional checked : boolean Inherited from # React.HTMLProps.checked children # \u2022 Optional children : ReactNode Inherited from # React.HTMLProps.children cite # \u2022 Optional cite : string Inherited from # React.HTMLProps.cite classID # \u2022 Optional classID : string Inherited from # React.HTMLProps.classID className # \u2022 Optional className : string Inherited from # React.HTMLProps.className colSpan # \u2022 Optional colSpan : number Inherited from # React.HTMLProps.colSpan color # \u2022 Optional color : string Inherited from # React.HTMLProps.color cols # \u2022 Optional cols : number Inherited from # React.HTMLProps.cols content # \u2022 Optional content : string Inherited from # React.HTMLProps.content contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLProps.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLProps.contextMenu controls # \u2022 Optional controls : boolean Inherited from # React.HTMLProps.controls coords # \u2022 Optional coords : string Inherited from # React.HTMLProps.coords crossOrigin # \u2022 Optional crossOrigin : string Inherited from # React.HTMLProps.crossOrigin dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLProps.dangerouslySetInnerHTML data # \u2022 Optional data : string Inherited from # React.HTMLProps.data datatype # \u2022 Optional datatype : string Inherited from # React.HTMLProps.datatype dateTime # \u2022 Optional dateTime : string Inherited from # React.HTMLProps.dateTime default # \u2022 Optional default : boolean Inherited from # React.HTMLProps.default defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLProps.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLProps.defaultValue defer # \u2022 Optional defer : boolean Inherited from # React.HTMLProps.defer dir # \u2022 Optional dir : string Inherited from # React.HTMLProps.dir disabled # \u2022 Optional disabled : boolean Overrides # React.HTMLProps.disabled download # \u2022 Optional download : any Inherited from # React.HTMLProps.download draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLProps.draggable encType # \u2022 Optional encType : string Inherited from # React.HTMLProps.encType form # \u2022 Optional form : string Inherited from # React.HTMLProps.form formAction # \u2022 Optional formAction : string Inherited from # React.HTMLProps.formAction formEncType # \u2022 Optional formEncType : string Inherited from # React.HTMLProps.formEncType formMethod # \u2022 Optional formMethod : string Inherited from # React.HTMLProps.formMethod formNoValidate # \u2022 Optional formNoValidate : boolean Inherited from # React.HTMLProps.formNoValidate formTarget # \u2022 Optional formTarget : string Inherited from # React.HTMLProps.formTarget frameBorder # \u2022 Optional frameBorder : string | number Inherited from # React.HTMLProps.frameBorder headers # \u2022 Optional headers : string Inherited from # React.HTMLProps.headers height # \u2022 Optional height : string | number Inherited from # React.HTMLProps.height hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLProps.hidden high # \u2022 Optional high : number Inherited from # React.HTMLProps.high href # \u2022 Optional href : string Overrides # React.HTMLProps.href hrefLang # \u2022 Optional hrefLang : string Inherited from # React.HTMLProps.hrefLang htmlFor # \u2022 Optional htmlFor : string Inherited from # React.HTMLProps.htmlFor httpEquiv # \u2022 Optional httpEquiv : string Inherited from # React.HTMLProps.httpEquiv icon # \u2022 Optional icon : string | Partial < IconProps > id # \u2022 Optional id : string Inherited from # React.HTMLProps.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLProps.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLProps.inputMode integrity # \u2022 Optional integrity : string Inherited from # React.HTMLProps.integrity is # \u2022 Optional is : string 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 Inherited from # React.HTMLProps.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLProps.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLProps.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLProps.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLProps.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLProps.itemType key # \u2022 Optional key : Key Inherited from # React.HTMLProps.key keyParams # \u2022 Optional keyParams : string Inherited from # React.HTMLProps.keyParams keyType # \u2022 Optional keyType : string Inherited from # React.HTMLProps.keyType kind # \u2022 Optional kind : string Inherited from # React.HTMLProps.kind label # \u2022 Optional label : string Inherited from # React.HTMLProps.label lang # \u2022 Optional lang : string Inherited from # React.HTMLProps.lang list # \u2022 Optional list : string Inherited from # React.HTMLProps.list loop # \u2022 Optional loop : boolean Inherited from # React.HTMLProps.loop low # \u2022 Optional low : number Inherited from # React.HTMLProps.low manifest # \u2022 Optional manifest : string Inherited from # React.HTMLProps.manifest marginHeight # \u2022 Optional marginHeight : number Inherited from # React.HTMLProps.marginHeight marginWidth # \u2022 Optional marginWidth : number Inherited from # React.HTMLProps.marginWidth max # \u2022 Optional max : string | number Inherited from # React.HTMLProps.max maxLength # \u2022 Optional maxLength : number Inherited from # React.HTMLProps.maxLength media # \u2022 Optional media : string Inherited from # React.HTMLProps.media mediaGroup # \u2022 Optional mediaGroup : string Inherited from # React.HTMLProps.mediaGroup method # \u2022 Optional method : string Inherited from # React.HTMLProps.method min # \u2022 Optional min : string | number Inherited from # React.HTMLProps.min minLength # \u2022 Optional minLength : number Inherited from # React.HTMLProps.minLength multiple # \u2022 Optional multiple : boolean Inherited from # React.HTMLProps.multiple muted # \u2022 Optional muted : boolean Inherited from # React.HTMLProps.muted name # \u2022 Optional name : string Inherited from # React.HTMLProps.name noValidate # \u2022 Optional noValidate : boolean Inherited from # React.HTMLProps.noValidate nonce # \u2022 Optional nonce : string Inherited from # React.HTMLProps.nonce onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLProps.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLProps.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLProps.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLProps.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLProps.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLProps.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLProps.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLProps.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLProps.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLProps.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLProps.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLProps.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLProps.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLProps.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLProps.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLProps.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLProps.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLProps.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLProps.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLProps.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLProps.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLProps.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLProps.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLProps.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLProps.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLProps.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLProps.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLProps.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLProps.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLProps.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLProps.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLProps.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLProps.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLProps.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLProps.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLProps.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLProps.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLProps.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLProps.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLProps.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLProps.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLProps.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLProps.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLProps.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLProps.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLProps.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLProps.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLProps.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLProps.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLProps.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLProps.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLProps.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLProps.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLProps.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLProps.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLProps.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLProps.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLProps.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLProps.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLProps.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLProps.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLProps.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLProps.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLProps.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLProps.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLProps.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLProps.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLProps.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLProps.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLProps.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLProps.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLProps.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLProps.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLProps.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLProps.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLProps.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLProps.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLProps.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLProps.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLProps.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLProps.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLProps.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLProps.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLProps.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLProps.onWheelCapture open # \u2022 Optional open : boolean Inherited from # React.HTMLProps.open optimum # \u2022 Optional optimum : number Inherited from # React.HTMLProps.optimum pattern # \u2022 Optional pattern : string Inherited from # React.HTMLProps.pattern placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLProps.placeholder playsInline # \u2022 Optional playsInline : boolean Inherited from # React.HTMLProps.playsInline poster # \u2022 Optional poster : string Inherited from # React.HTMLProps.poster prefix # \u2022 Optional prefix : string Inherited from # React.HTMLProps.prefix preload # \u2022 Optional preload : string Inherited from # React.HTMLProps.preload property # \u2022 Optional property : string Inherited from # React.HTMLProps.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLProps.radioGroup readOnly # \u2022 Optional readOnly : boolean Inherited from # React.HTMLProps.readOnly ref # \u2022 Optional ref : LegacyRef Inherited from # React.HTMLProps.ref rel # \u2022 Optional rel : string Inherited from # React.HTMLProps.rel required # \u2022 Optional required : boolean Inherited from # React.HTMLProps.required resource # \u2022 Optional resource : string Inherited from # React.HTMLProps.resource results # \u2022 Optional results : number Inherited from # React.HTMLProps.results reversed # \u2022 Optional reversed : boolean Inherited from # React.HTMLProps.reversed role # \u2022 Optional role : string Inherited from # React.HTMLProps.role rowSpan # \u2022 Optional rowSpan : number Inherited from # React.HTMLProps.rowSpan rows # \u2022 Optional rows : number Inherited from # React.HTMLProps.rows sandbox # \u2022 Optional sandbox : string Inherited from # React.HTMLProps.sandbox scope # \u2022 Optional scope : string Inherited from # React.HTMLProps.scope scoped # \u2022 Optional scoped : boolean Inherited from # React.HTMLProps.scoped scrolling # \u2022 Optional scrolling : string Inherited from # React.HTMLProps.scrolling seamless # \u2022 Optional seamless : boolean Inherited from # React.HTMLProps.seamless security # \u2022 Optional security : string Inherited from # React.HTMLProps.security selected # \u2022 Optional selected : boolean Inherited from # React.HTMLProps.selected shape # \u2022 Optional shape : string Inherited from # React.HTMLProps.shape size # \u2022 Optional size : number Inherited from # React.HTMLProps.size sizes # \u2022 Optional sizes : string Inherited from # React.HTMLProps.sizes slot # \u2022 Optional slot : string Inherited from # React.HTMLProps.slot spacer # \u2022 Optional spacer : boolean span # \u2022 Optional span : number Inherited from # React.HTMLProps.span spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLProps.spellCheck src # \u2022 Optional src : string Inherited from # React.HTMLProps.src srcDoc # \u2022 Optional srcDoc : string Inherited from # React.HTMLProps.srcDoc srcLang # \u2022 Optional srcLang : string Inherited from # React.HTMLProps.srcLang srcSet # \u2022 Optional srcSet : string Inherited from # React.HTMLProps.srcSet start # \u2022 Optional start : number Inherited from # React.HTMLProps.start step # \u2022 Optional step : string | number Inherited from # React.HTMLProps.step style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLProps.style summary # \u2022 Optional summary : string Inherited from # React.HTMLProps.summary suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLProps.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLProps.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLProps.tabIndex target # \u2022 Optional target : string Inherited from # React.HTMLProps.target title # \u2022 Optional title : string Inherited from # React.HTMLProps.title translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLProps.translate type # \u2022 Optional type : string Inherited from # React.HTMLProps.type typeof # \u2022 Optional typeof : string Inherited from # React.HTMLProps.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLProps.unselectable useMap # \u2022 Optional useMap : string Inherited from # React.HTMLProps.useMap value # \u2022 Optional value : string | number | readonly string [] Inherited from # React.HTMLProps.value vocab # \u2022 Optional vocab : string Inherited from # React.HTMLProps.vocab width # \u2022 Optional width : string | number Inherited from # React.HTMLProps.width wmode # \u2022 Optional wmode : string Inherited from # React.HTMLProps.wmode wrap # \u2022 Optional wrap : string Inherited from # React.HTMLProps.wrap","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#interface-menuitemprops","text":"Renderer . Component .MenuItemProps","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#hierarchy","text":"HTMLProps \u21b3 MenuItemProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#properties","text":"about accept acceptCharset accessKey action active allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv icon id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot spacer span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#accept","text":"\u2022 Optional accept : string","title":"accept"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#acceptcharset","text":"\u2022 Optional acceptCharset : string","title":"acceptCharset"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#allowfullscreen","text":"\u2022 Optional allowFullScreen : boolean","title":"allowFullScreen"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#allowtransparency","text":"\u2022 Optional allowTransparency : boolean","title":"allowTransparency"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#alt","text":"\u2022 Optional alt : string","title":"alt"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#as","text":"\u2022 Optional as : string","title":"as"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#async","text":"\u2022 Optional async : boolean","title":"async"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autocomplete","text":"\u2022 Optional autoComplete : string","title":"autoComplete"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autoplay","text":"\u2022 Optional autoPlay : boolean","title":"autoPlay"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#capture","text":"\u2022 Optional capture : string | boolean","title":"capture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#cellpadding","text":"\u2022 Optional cellPadding : string | number","title":"cellPadding"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#cellspacing","text":"\u2022 Optional cellSpacing : string | number","title":"cellSpacing"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#challenge","text":"\u2022 Optional challenge : string","title":"challenge"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#charset","text":"\u2022 Optional charSet : string","title":"charSet"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#cite","text":"\u2022 Optional cite : string","title":"cite"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#classid","text":"\u2022 Optional classID : string","title":"classID"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#colspan","text":"\u2022 Optional colSpan : number","title":"colSpan"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#cols","text":"\u2022 Optional cols : number","title":"cols"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#content","text":"\u2022 Optional content : string","title":"content"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#controls","text":"\u2022 Optional controls : boolean","title":"controls"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#coords","text":"\u2022 Optional coords : string","title":"coords"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#crossorigin","text":"\u2022 Optional crossOrigin : string","title":"crossOrigin"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#data","text":"\u2022 Optional data : string","title":"data"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#datetime","text":"\u2022 Optional dateTime : string","title":"dateTime"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#defer","text":"\u2022 Optional defer : boolean","title":"defer"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#download","text":"\u2022 Optional download : any","title":"download"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#enctype","text":"\u2022 Optional encType : string","title":"encType"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#form","text":"\u2022 Optional form : string","title":"form"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#formaction","text":"\u2022 Optional formAction : string","title":"formAction"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#formenctype","text":"\u2022 Optional formEncType : string","title":"formEncType"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#formmethod","text":"\u2022 Optional formMethod : string","title":"formMethod"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#formnovalidate","text":"\u2022 Optional formNoValidate : boolean","title":"formNoValidate"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#formtarget","text":"\u2022 Optional formTarget : string","title":"formTarget"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#frameborder","text":"\u2022 Optional frameBorder : string | number","title":"frameBorder"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#headers","text":"\u2022 Optional headers : string","title":"headers"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#high","text":"\u2022 Optional high : number","title":"high"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#hreflang","text":"\u2022 Optional hrefLang : string","title":"hrefLang"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#httpequiv","text":"\u2022 Optional httpEquiv : string","title":"httpEquiv"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#icon","text":"\u2022 Optional icon : string | Partial < IconProps >","title":"icon"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#integrity","text":"\u2022 Optional integrity : string","title":"integrity"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#key","text":"\u2022 Optional key : Key","title":"key"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#keyparams","text":"\u2022 Optional keyParams : string","title":"keyParams"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#keytype","text":"\u2022 Optional keyType : string","title":"keyType"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#kind","text":"\u2022 Optional kind : string","title":"kind"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#label","text":"\u2022 Optional label : string","title":"label"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#list","text":"\u2022 Optional list : string","title":"list"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#loop","text":"\u2022 Optional loop : boolean","title":"loop"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#low","text":"\u2022 Optional low : number","title":"low"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#manifest","text":"\u2022 Optional manifest : string","title":"manifest"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#marginheight","text":"\u2022 Optional marginHeight : number","title":"marginHeight"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#marginwidth","text":"\u2022 Optional marginWidth : number","title":"marginWidth"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#max","text":"\u2022 Optional max : string | number","title":"max"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#maxlength","text":"\u2022 Optional maxLength : number","title":"maxLength"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#media","text":"\u2022 Optional media : string","title":"media"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#mediagroup","text":"\u2022 Optional mediaGroup : string","title":"mediaGroup"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#method","text":"\u2022 Optional method : string","title":"method"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#min","text":"\u2022 Optional min : string | number","title":"min"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#minlength","text":"\u2022 Optional minLength : number","title":"minLength"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#multiple","text":"\u2022 Optional multiple : boolean","title":"multiple"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#muted","text":"\u2022 Optional muted : boolean","title":"muted"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#nonce","text":"\u2022 Optional nonce : string","title":"nonce"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#open","text":"\u2022 Optional open : boolean","title":"open"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#optimum","text":"\u2022 Optional optimum : number","title":"optimum"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#pattern","text":"\u2022 Optional pattern : string","title":"pattern"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#playsinline","text":"\u2022 Optional playsInline : boolean","title":"playsInline"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#poster","text":"\u2022 Optional poster : string","title":"poster"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#preload","text":"\u2022 Optional preload : string","title":"preload"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#ref","text":"\u2022 Optional ref : LegacyRef ","title":"ref"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#rel","text":"\u2022 Optional rel : string","title":"rel"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#required","text":"\u2022 Optional required : boolean","title":"required"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#reversed","text":"\u2022 Optional reversed : boolean","title":"reversed"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#rowspan","text":"\u2022 Optional rowSpan : number","title":"rowSpan"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#rows","text":"\u2022 Optional rows : number","title":"rows"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#sandbox","text":"\u2022 Optional sandbox : string","title":"sandbox"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#scope","text":"\u2022 Optional scope : string","title":"scope"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#scoped","text":"\u2022 Optional scoped : boolean","title":"scoped"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#scrolling","text":"\u2022 Optional scrolling : string","title":"scrolling"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#seamless","text":"\u2022 Optional seamless : boolean","title":"seamless"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#shape","text":"\u2022 Optional shape : string","title":"shape"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#size","text":"\u2022 Optional size : number","title":"size"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#sizes","text":"\u2022 Optional sizes : string","title":"sizes"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#spacer","text":"\u2022 Optional spacer : boolean","title":"spacer"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#span","text":"\u2022 Optional span : number","title":"span"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#src","text":"\u2022 Optional src : string","title":"src"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#srcdoc","text":"\u2022 Optional srcDoc : string","title":"srcDoc"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#srclang","text":"\u2022 Optional srcLang : string","title":"srcLang"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#srcset","text":"\u2022 Optional srcSet : string","title":"srcSet"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#start","text":"\u2022 Optional start : number","title":"start"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#step","text":"\u2022 Optional step : string | number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#summary","text":"\u2022 Optional summary : string","title":"summary"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#target","text":"\u2022 Optional target : string","title":"target"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#usemap","text":"\u2022 Optional useMap : string","title":"useMap"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#value","text":"\u2022 Optional value : string | number | readonly string []","title":"value"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#wmode","text":"\u2022 Optional wmode : string","title":"wmode"},{"location":"extensions/api/interfaces/renderer.component.menuitemprops/#wrap","text":"\u2022 Optional wrap : string","title":"wrap"},{"location":"extensions/api/interfaces/renderer.component.menuposition/","text":"Interface: MenuPosition # Renderer . Component .MenuPosition Table of contents # Properties # bottom left right top Properties # bottom # \u2022 Optional bottom : boolean left # \u2022 Optional left : boolean right # \u2022 Optional right : boolean top # \u2022 Optional top : boolean","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#interface-menuposition","text":"Renderer . Component .MenuPosition","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#properties","text":"bottom left right top","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#bottom","text":"\u2022 Optional bottom : boolean","title":"bottom"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#left","text":"\u2022 Optional left : boolean","title":"left"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#right","text":"\u2022 Optional right : boolean","title":"right"},{"location":"extensions/api/interfaces/renderer.component.menuposition/#top","text":"\u2022 Optional top : boolean","title":"top"},{"location":"extensions/api/interfaces/renderer.component.menuprops/","text":"Interface: MenuProps # Renderer . Component .MenuProps Table of contents # Properties # autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll htmlFor id isOpen position toggleEvent usePortal Methods # close open Properties # autoFocus # \u2022 Optional autoFocus : boolean children # \u2022 Optional children : ReactNode className # \u2022 Optional className : string closeOnClickItem # \u2022 Optional closeOnClickItem : boolean closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean closeOnScroll # \u2022 Optional closeOnScroll : boolean htmlFor # \u2022 Optional htmlFor : string id # \u2022 Optional id : string isOpen # \u2022 Optional isOpen : boolean position # \u2022 Optional position : MenuPosition toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" usePortal # \u2022 Optional usePortal : boolean | HTMLElement Methods # close # \u25b8 close (): void Returns # void open # \u25b8 open (): void Returns # void","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#interface-menuprops","text":"Renderer . Component .MenuProps","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#properties","text":"autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll htmlFor id isOpen position toggleEvent usePortal","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/interfaces/renderer.component.menuprops/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/interfaces/renderer.component.notification/","text":"Interface: Notification # Renderer . Component .Notification Table of contents # Properties # id message status timeout Methods # onClose Properties # id # \u2022 Optional id : NotificationId message # \u2022 message : NotificationMessage status # \u2022 Optional status : NotificationStatus timeout # \u2022 Optional timeout : number Methods # onClose # \u25b8 Optional onClose (): void Returns # void","title":"Interface: Notification"},{"location":"extensions/api/interfaces/renderer.component.notification/#interface-notification","text":"Renderer . Component .Notification","title":"Interface: Notification"},{"location":"extensions/api/interfaces/renderer.component.notification/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.notification/#properties","text":"id message status timeout","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.notification/#methods","text":"onClose","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.notification/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.notification/#id","text":"\u2022 Optional id : NotificationId","title":"id"},{"location":"extensions/api/interfaces/renderer.component.notification/#message","text":"\u2022 message : NotificationMessage","title":"message"},{"location":"extensions/api/interfaces/renderer.component.notification/#status","text":"\u2022 Optional status : NotificationStatus","title":"status"},{"location":"extensions/api/interfaces/renderer.component.notification/#timeout","text":"\u2022 Optional timeout : number","title":"timeout"},{"location":"extensions/api/interfaces/renderer.component.notification/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.notification/#onclose","text":"\u25b8 Optional onClose (): void","title":"onClose"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/","text":"Interface: RadioGroupProps # Renderer . Component .RadioGroupProps Table of contents # Properties # asButtons className disabled value Methods # onChange Properties # asButtons # \u2022 Optional asButtons : boolean className # \u2022 Optional className : any disabled # \u2022 Optional disabled : boolean value # \u2022 Optional value : any Methods # onChange # \u25b8 Optional onChange ( value ): void Parameters # Name Type value string Returns # void","title":"Interface: RadioGroupProps"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#interface-radiogroupprops","text":"Renderer . Component .RadioGroupProps","title":"Interface: RadioGroupProps"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#properties","text":"asButtons className disabled value","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#asbuttons","text":"\u2022 Optional asButtons : boolean","title":"asButtons"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#classname","text":"\u2022 Optional className : any","title":"className"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#value","text":"\u2022 Optional value : any","title":"value"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.radiogroupprops/#onchange","text":"\u25b8 Optional onChange ( value ): void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.selectoption/","text":"Interface: SelectOption # Renderer . Component .SelectOption Type parameters # Name Type T T = any Table of contents # Properties # label value Properties # label # \u2022 Optional label : ReactNode value # \u2022 value : T","title":"Interface: SelectOption"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#interface-selectoptiont","text":"Renderer . Component .SelectOption","title":"Interface: SelectOption<T>"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#type-parameters","text":"Name Type T T = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#properties","text":"label value","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.selectoption/#value","text":"\u2022 value : T","title":"value"},{"location":"extensions/api/interfaces/renderer.component.selectprops/","text":"Interface: SelectProps # Renderer . Component .SelectProps Type parameters # Name Type T T = any Hierarchy # ReactSelectProps CreatableProps \u21b3 SelectProps Table of contents # Properties # allowCreateWhileLoading aria-label aria-labelledby autoConvertOptions autoFocus backspaceRemovesValue blurInputOnSelect captureMenuScroll className classNamePrefix closeMenuOnScroll closeMenuOnSelect components controlShouldRenderValue createOptionPosition defaultInputValue defaultMenuIsOpen defaultValue delimiter escapeClearsValue filterOption formatCreateLabel formatGroupLabel formatOptionLabel getNewOptionData getOptionLabel getOptionValue hideSelectedOptions id inputId inputValue instanceId isClearable isCreatable isDisabled isLoading isMulti isOptionDisabled isOptionSelected isRtl isSearchable isValidNewOption loadingMessage maxMenuHeight menuClass menuIsOpen menuPlacement menuPortalTarget menuPosition menuShouldBlockScroll menuShouldScrollIntoView minMenuHeight name noOptionsMessage onBlur onCreateOption onFocus onInputChange onKeyDown onMenuClose onMenuOpen onMenuScrollToBottom onMenuScrollToTop openMenuOnClick openMenuOnFocus options pageSize placeholder screenReaderStatus styles tabIndex tabSelectsValue theme themeName value Methods # onChange Properties # allowCreateWhileLoading # \u2022 Optional allowCreateWhileLoading : boolean Inherited from # CreatableProps.allowCreateWhileLoading aria-label # \u2022 Optional aria-label : string Inherited from # ReactSelectProps.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Inherited from # ReactSelectProps.aria-labelledby autoConvertOptions # \u2022 Optional autoConvertOptions : boolean autoFocus # \u2022 Optional autoFocus : boolean Inherited from # ReactSelectProps.autoFocus backspaceRemovesValue # \u2022 Optional backspaceRemovesValue : boolean Inherited from # ReactSelectProps.backspaceRemovesValue blurInputOnSelect # \u2022 Optional blurInputOnSelect : boolean Inherited from # ReactSelectProps.blurInputOnSelect captureMenuScroll # \u2022 Optional captureMenuScroll : boolean Inherited from # ReactSelectProps.captureMenuScroll className # \u2022 Optional className : string Inherited from # ReactSelectProps.className classNamePrefix # \u2022 Optional classNamePrefix : string Inherited from # ReactSelectProps.classNamePrefix closeMenuOnScroll # \u2022 Optional closeMenuOnScroll : boolean | EventListener Inherited from # ReactSelectProps.closeMenuOnScroll closeMenuOnSelect # \u2022 Optional closeMenuOnSelect : boolean Inherited from # ReactSelectProps.closeMenuOnSelect components # \u2022 Optional components : Partial > Inherited from # ReactSelectProps.components controlShouldRenderValue # \u2022 Optional controlShouldRenderValue : boolean Inherited from # ReactSelectProps.controlShouldRenderValue createOptionPosition # \u2022 Optional createOptionPosition : \"first\" | \"last\" Inherited from # CreatableProps.createOptionPosition defaultInputValue # \u2022 Optional defaultInputValue : string Inherited from # ReactSelectProps.defaultInputValue defaultMenuIsOpen # \u2022 Optional defaultMenuIsOpen : boolean Inherited from # ReactSelectProps.defaultMenuIsOpen defaultValue # \u2022 Optional defaultValue : T | OptionsType Inherited from # ReactSelectProps.defaultValue delimiter # \u2022 Optional delimiter : string Inherited from # ReactSelectProps.delimiter escapeClearsValue # \u2022 Optional escapeClearsValue : boolean Inherited from # ReactSelectProps.escapeClearsValue filterOption # \u2022 Optional filterOption : ( option : Option , rawInput : string ) => boolean Type declaration # \u25b8 ( option , rawInput ): boolean Parameters # Name Type option Option rawInput string Returns # boolean Inherited from # ReactSelectProps.filterOption formatCreateLabel # \u2022 Optional formatCreateLabel : ( inputValue : string ) => ReactNode Type declaration # \u25b8 ( inputValue ): ReactNode Parameters # Name Type inputValue string Returns # ReactNode Inherited from # CreatableProps.formatCreateLabel formatGroupLabel # \u2022 Optional formatGroupLabel : formatGroupLabel Inherited from # ReactSelectProps.formatGroupLabel formatOptionLabel # \u2022 Optional formatOptionLabel : ( option : T , labelMeta : FormatOptionLabelMeta ) => ReactNode Type declaration # \u25b8 ( option , labelMeta ): ReactNode Parameters # Name Type option T labelMeta FormatOptionLabelMeta Returns # ReactNode Inherited from # ReactSelectProps.formatOptionLabel getNewOptionData # \u2022 Optional getNewOptionData : ( inputValue : string , optionLabel : ReactNode ) => T Type declaration # \u25b8 ( inputValue , optionLabel ): T Parameters # Name Type inputValue string optionLabel ReactNode Returns # T Inherited from # CreatableProps.getNewOptionData getOptionLabel # \u2022 Optional getOptionLabel : getOptionLabel Inherited from # ReactSelectProps.getOptionLabel getOptionValue # \u2022 Optional getOptionValue : getOptionValue Inherited from # ReactSelectProps.getOptionValue hideSelectedOptions # \u2022 Optional hideSelectedOptions : boolean Inherited from # ReactSelectProps.hideSelectedOptions id # \u2022 Optional id : string Inherited from # ReactSelectProps.id inputId # \u2022 Optional inputId : string Inherited from # ReactSelectProps.inputId inputValue # \u2022 Optional inputValue : string Inherited from # ReactSelectProps.inputValue instanceId # \u2022 Optional instanceId : string | number Inherited from # ReactSelectProps.instanceId isClearable # \u2022 Optional isClearable : boolean Inherited from # ReactSelectProps.isClearable isCreatable # \u2022 Optional isCreatable : boolean isDisabled # \u2022 Optional isDisabled : boolean Inherited from # ReactSelectProps.isDisabled isLoading # \u2022 Optional isLoading : boolean Inherited from # ReactSelectProps.isLoading isMulti # \u2022 Optional isMulti : boolean Inherited from # ReactSelectProps.isMulti isOptionDisabled # \u2022 Optional isOptionDisabled : ( option : T , options : OptionsType ) => boolean Type declaration # \u25b8 ( option , options ): boolean Parameters # Name Type option T options OptionsType Returns # boolean Inherited from # ReactSelectProps.isOptionDisabled isOptionSelected # \u2022 Optional isOptionSelected : ( option : T , options : OptionsType ) => boolean Type declaration # \u25b8 ( option , options ): boolean Parameters # Name Type option T options OptionsType Returns # boolean Inherited from # ReactSelectProps.isOptionSelected isRtl # \u2022 Optional isRtl : boolean Inherited from # ReactSelectProps.isRtl isSearchable # \u2022 Optional isSearchable : boolean Inherited from # ReactSelectProps.isSearchable isValidNewOption # \u2022 Optional isValidNewOption : ( inputValue : string , value : T | OptionsType , options : OptionsType | GroupedOptionsType ) => boolean Type declaration # \u25b8 ( inputValue , value , options ): boolean Parameters # Name Type inputValue string value T | OptionsType options OptionsType | GroupedOptionsType Returns # boolean Inherited from # CreatableProps.isValidNewOption loadingMessage # \u2022 Optional loadingMessage : ( obj : { inputValue : string }) => string Type declaration # \u25b8 ( obj ): string Parameters # Name Type obj Object obj.inputValue string Returns # string Inherited from # ReactSelectProps.loadingMessage maxMenuHeight # \u2022 Optional maxMenuHeight : number Inherited from # ReactSelectProps.maxMenuHeight menuClass # \u2022 Optional menuClass : string menuIsOpen # \u2022 Optional menuIsOpen : boolean Inherited from # ReactSelectProps.menuIsOpen menuPlacement # \u2022 Optional menuPlacement : MenuPlacement Inherited from # ReactSelectProps.menuPlacement menuPortalTarget # \u2022 Optional menuPortalTarget : HTMLElement Inherited from # ReactSelectProps.menuPortalTarget menuPosition # \u2022 Optional menuPosition : MenuPosition Inherited from # ReactSelectProps.menuPosition menuShouldBlockScroll # \u2022 Optional menuShouldBlockScroll : boolean Inherited from # ReactSelectProps.menuShouldBlockScroll menuShouldScrollIntoView # \u2022 Optional menuShouldScrollIntoView : boolean Inherited from # ReactSelectProps.menuShouldScrollIntoView minMenuHeight # \u2022 Optional minMenuHeight : number Inherited from # ReactSelectProps.minMenuHeight name # \u2022 Optional name : string Inherited from # ReactSelectProps.name noOptionsMessage # \u2022 Optional noOptionsMessage : ( obj : { inputValue : string }) => string Type declaration # \u25b8 ( obj ): string Parameters # Name Type obj Object obj.inputValue string Returns # string Inherited from # ReactSelectProps.noOptionsMessage onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # ReactSelectProps.onBlur onCreateOption # \u2022 Optional onCreateOption : ( inputValue : string ) => void Type declaration # \u25b8 ( inputValue ): void Parameters # Name Type inputValue string Returns # void Inherited from # CreatableProps.onCreateOption onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # ReactSelectProps.onFocus onInputChange # \u2022 Optional onInputChange : ( newValue : string , actionMeta : InputActionMeta ) => void Type declaration # \u25b8 ( newValue , actionMeta ): void Parameters # Name Type newValue string actionMeta InputActionMeta Returns # void Inherited from # ReactSelectProps.onInputChange onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # ReactSelectProps.onKeyDown onMenuClose # \u2022 Optional onMenuClose : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # ReactSelectProps.onMenuClose onMenuOpen # \u2022 Optional onMenuOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # ReactSelectProps.onMenuOpen onMenuScrollToBottom # \u2022 Optional onMenuScrollToBottom : ( event : SyntheticEvent ) => void Type declaration # \u25b8 ( event ): void Parameters # Name Type event SyntheticEvent Returns # void Inherited from # ReactSelectProps.onMenuScrollToBottom onMenuScrollToTop # \u2022 Optional onMenuScrollToTop : ( event : SyntheticEvent ) => void Type declaration # \u25b8 ( event ): void Parameters # Name Type event SyntheticEvent Returns # void Inherited from # ReactSelectProps.onMenuScrollToTop openMenuOnClick # \u2022 Optional openMenuOnClick : boolean Inherited from # ReactSelectProps.openMenuOnClick openMenuOnFocus # \u2022 Optional openMenuOnFocus : boolean Inherited from # ReactSelectProps.openMenuOnFocus options # \u2022 Optional options : OptionsType | GroupedOptionsType Inherited from # ReactSelectProps.options pageSize # \u2022 Optional pageSize : number Inherited from # ReactSelectProps.pageSize placeholder # \u2022 Optional placeholder : ReactNode Inherited from # ReactSelectProps.placeholder screenReaderStatus # \u2022 Optional screenReaderStatus : ( obj : { count : number }) => string Type declaration # \u25b8 ( obj ): string Parameters # Name Type obj Object obj.count number Returns # string Inherited from # ReactSelectProps.screenReaderStatus styles # \u2022 Optional styles : Partial > Inherited from # ReactSelectProps.styles tabIndex # \u2022 Optional tabIndex : string Inherited from # ReactSelectProps.tabIndex tabSelectsValue # \u2022 Optional tabSelectsValue : boolean Inherited from # ReactSelectProps.tabSelectsValue theme # \u2022 Optional theme : ThemeConfig Inherited from # ReactSelectProps.theme themeName # \u2022 Optional themeName : \"lens\" | \"light\" | \"outlined\" | \"dark\" value # \u2022 Optional value : T Overrides # ReactSelectProps.value Methods # onChange # \u25b8 Optional onChange ( option , meta? ): void Parameters # Name Type option T meta? ActionMeta Returns # void Overrides # ReactSelectProps.onChange","title":"Interface: SelectProps"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#interface-selectpropst","text":"Renderer . Component .SelectProps","title":"Interface: SelectProps<T>"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#type-parameters","text":"Name Type T T = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#hierarchy","text":"ReactSelectProps CreatableProps \u21b3 SelectProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#properties","text":"allowCreateWhileLoading aria-label aria-labelledby autoConvertOptions autoFocus backspaceRemovesValue blurInputOnSelect captureMenuScroll className classNamePrefix closeMenuOnScroll closeMenuOnSelect components controlShouldRenderValue createOptionPosition defaultInputValue defaultMenuIsOpen defaultValue delimiter escapeClearsValue filterOption formatCreateLabel formatGroupLabel formatOptionLabel getNewOptionData getOptionLabel getOptionValue hideSelectedOptions id inputId inputValue instanceId isClearable isCreatable isDisabled isLoading isMulti isOptionDisabled isOptionSelected isRtl isSearchable isValidNewOption loadingMessage maxMenuHeight menuClass menuIsOpen menuPlacement menuPortalTarget menuPosition menuShouldBlockScroll menuShouldScrollIntoView minMenuHeight name noOptionsMessage onBlur onCreateOption onFocus onInputChange onKeyDown onMenuClose onMenuOpen onMenuScrollToBottom onMenuScrollToTop openMenuOnClick openMenuOnFocus options pageSize placeholder screenReaderStatus styles tabIndex tabSelectsValue theme themeName value","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#allowcreatewhileloading","text":"\u2022 Optional allowCreateWhileLoading : boolean","title":"allowCreateWhileLoading"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#aria-label","text":"\u2022 Optional aria-label : string","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#autoconvertoptions","text":"\u2022 Optional autoConvertOptions : boolean","title":"autoConvertOptions"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#backspaceremovesvalue","text":"\u2022 Optional backspaceRemovesValue : boolean","title":"backspaceRemovesValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#blurinputonselect","text":"\u2022 Optional blurInputOnSelect : boolean","title":"blurInputOnSelect"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#capturemenuscroll","text":"\u2022 Optional captureMenuScroll : boolean","title":"captureMenuScroll"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#classnameprefix","text":"\u2022 Optional classNamePrefix : string","title":"classNamePrefix"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#closemenuonscroll","text":"\u2022 Optional closeMenuOnScroll : boolean | EventListener","title":"closeMenuOnScroll"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#closemenuonselect","text":"\u2022 Optional closeMenuOnSelect : boolean","title":"closeMenuOnSelect"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#components","text":"\u2022 Optional components : Partial >","title":"components"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#controlshouldrendervalue","text":"\u2022 Optional controlShouldRenderValue : boolean","title":"controlShouldRenderValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#createoptionposition","text":"\u2022 Optional createOptionPosition : \"first\" | \"last\"","title":"createOptionPosition"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#defaultinputvalue","text":"\u2022 Optional defaultInputValue : string","title":"defaultInputValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#defaultmenuisopen","text":"\u2022 Optional defaultMenuIsOpen : boolean","title":"defaultMenuIsOpen"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#defaultvalue","text":"\u2022 Optional defaultValue : T | OptionsType ","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#delimiter","text":"\u2022 Optional delimiter : string","title":"delimiter"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#escapeclearsvalue","text":"\u2022 Optional escapeClearsValue : boolean","title":"escapeClearsValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#filteroption","text":"\u2022 Optional filterOption : ( option : Option , rawInput : string ) => boolean","title":"filterOption"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#formatcreatelabel","text":"\u2022 Optional formatCreateLabel : ( inputValue : string ) => ReactNode","title":"formatCreateLabel"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#formatgrouplabel","text":"\u2022 Optional formatGroupLabel : formatGroupLabel ","title":"formatGroupLabel"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#formatoptionlabel","text":"\u2022 Optional formatOptionLabel : ( option : T , labelMeta : FormatOptionLabelMeta ) => ReactNode","title":"formatOptionLabel"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#getnewoptiondata","text":"\u2022 Optional getNewOptionData : ( inputValue : string , optionLabel : ReactNode ) => T","title":"getNewOptionData"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#getoptionlabel","text":"\u2022 Optional getOptionLabel : getOptionLabel ","title":"getOptionLabel"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#getoptionvalue","text":"\u2022 Optional getOptionValue : getOptionValue ","title":"getOptionValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#hideselectedoptions","text":"\u2022 Optional hideSelectedOptions : boolean","title":"hideSelectedOptions"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#inputid","text":"\u2022 Optional inputId : string","title":"inputId"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#inputvalue","text":"\u2022 Optional inputValue : string","title":"inputValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#instanceid","text":"\u2022 Optional instanceId : string | number","title":"instanceId"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isclearable","text":"\u2022 Optional isClearable : boolean","title":"isClearable"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#iscreatable","text":"\u2022 Optional isCreatable : boolean","title":"isCreatable"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isdisabled","text":"\u2022 Optional isDisabled : boolean","title":"isDisabled"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isloading","text":"\u2022 Optional isLoading : boolean","title":"isLoading"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#ismulti","text":"\u2022 Optional isMulti : boolean","title":"isMulti"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isoptiondisabled","text":"\u2022 Optional isOptionDisabled : ( option : T , options : OptionsType ) => boolean","title":"isOptionDisabled"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isoptionselected","text":"\u2022 Optional isOptionSelected : ( option : T , options : OptionsType ) => boolean","title":"isOptionSelected"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isrtl","text":"\u2022 Optional isRtl : boolean","title":"isRtl"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#issearchable","text":"\u2022 Optional isSearchable : boolean","title":"isSearchable"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#isvalidnewoption","text":"\u2022 Optional isValidNewOption : ( inputValue : string , value : T | OptionsType , options : OptionsType | GroupedOptionsType ) => boolean","title":"isValidNewOption"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#loadingmessage","text":"\u2022 Optional loadingMessage : ( obj : { inputValue : string }) => string","title":"loadingMessage"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#maxmenuheight","text":"\u2022 Optional maxMenuHeight : number","title":"maxMenuHeight"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menuclass","text":"\u2022 Optional menuClass : string","title":"menuClass"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menuisopen","text":"\u2022 Optional menuIsOpen : boolean","title":"menuIsOpen"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menuplacement","text":"\u2022 Optional menuPlacement : MenuPlacement","title":"menuPlacement"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menuportaltarget","text":"\u2022 Optional menuPortalTarget : HTMLElement","title":"menuPortalTarget"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menuposition","text":"\u2022 Optional menuPosition : MenuPosition","title":"menuPosition"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menushouldblockscroll","text":"\u2022 Optional menuShouldBlockScroll : boolean","title":"menuShouldBlockScroll"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#menushouldscrollintoview","text":"\u2022 Optional menuShouldScrollIntoView : boolean","title":"menuShouldScrollIntoView"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#minmenuheight","text":"\u2022 Optional minMenuHeight : number","title":"minMenuHeight"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#nooptionsmessage","text":"\u2022 Optional noOptionsMessage : ( obj : { inputValue : string }) => string","title":"noOptionsMessage"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#oncreateoption","text":"\u2022 Optional onCreateOption : ( inputValue : string ) => void","title":"onCreateOption"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#oninputchange","text":"\u2022 Optional onInputChange : ( newValue : string , actionMeta : InputActionMeta ) => void","title":"onInputChange"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onmenuclose","text":"\u2022 Optional onMenuClose : () => void","title":"onMenuClose"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onmenuopen","text":"\u2022 Optional onMenuOpen : () => void","title":"onMenuOpen"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onmenuscrolltobottom","text":"\u2022 Optional onMenuScrollToBottom : ( event : SyntheticEvent ) => void","title":"onMenuScrollToBottom"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onmenuscrolltotop","text":"\u2022 Optional onMenuScrollToTop : ( event : SyntheticEvent ) => void","title":"onMenuScrollToTop"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#openmenuonclick","text":"\u2022 Optional openMenuOnClick : boolean","title":"openMenuOnClick"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#openmenuonfocus","text":"\u2022 Optional openMenuOnFocus : boolean","title":"openMenuOnFocus"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#options","text":"\u2022 Optional options : OptionsType | GroupedOptionsType ","title":"options"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#pagesize","text":"\u2022 Optional pageSize : number","title":"pageSize"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#placeholder","text":"\u2022 Optional placeholder : ReactNode","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#screenreaderstatus","text":"\u2022 Optional screenReaderStatus : ( obj : { count : number }) => string","title":"screenReaderStatus"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#styles","text":"\u2022 Optional styles : Partial >","title":"styles"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#tabindex","text":"\u2022 Optional tabIndex : string","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#tabselectsvalue","text":"\u2022 Optional tabSelectsValue : boolean","title":"tabSelectsValue"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#theme","text":"\u2022 Optional theme : ThemeConfig","title":"theme"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#themename","text":"\u2022 Optional themeName : \"lens\" | \"light\" | \"outlined\" | \"dark\"","title":"themeName"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#value","text":"\u2022 Optional value : T","title":"value"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.selectprops/#onchange","text":"\u25b8 Optional onChange ( option , meta? ): void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/","text":"Interface: SettingLayoutProps # Renderer . Component .SettingLayoutProps Hierarchy # DOMAttributes \u21b3 SettingLayoutProps Table of contents # Properties # back children className contentClass contentGaps dangerouslySetInnerHTML navigation onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture provideBackButtonNavigation Properties # back # \u2022 Optional back : ( evt : MouseEvent \\| KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt MouseEvent | KeyboardEvent Returns # void children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName contentGaps # \u2022 Optional contentGaps : boolean dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML navigation # \u2022 Optional navigation : ReactNode onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture provideBackButtonNavigation # \u2022 Optional provideBackButtonNavigation : boolean","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#interface-settinglayoutprops","text":"Renderer . Component .SettingLayoutProps","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#hierarchy","text":"DOMAttributes \u21b3 SettingLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#properties","text":"back children className contentClass contentGaps dangerouslySetInnerHTML navigation onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture provideBackButtonNavigation","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#back","text":"\u2022 Optional back : ( evt : MouseEvent \\| KeyboardEvent ) => void","title":"back"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#contentgaps","text":"\u2022 Optional contentGaps : boolean","title":"contentGaps"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#navigation","text":"\u2022 Optional navigation : ReactNode","title":"navigation"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.settinglayoutprops/#providebackbuttonnavigation","text":"\u2022 Optional provideBackButtonNavigation : boolean","title":"provideBackButtonNavigation"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/","text":"Interface: SliderProps # Renderer . Component .SliderProps Hierarchy # Omit \u21b3 SliderProps Table of contents # Properties # ThumbComponent ValueLabelComponent about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className classes color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable getAriaLabel getAriaValueText hidden id inlist innerRef inputMode is itemID itemProp itemRef itemScope itemType key lang marks max min name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChangeCapture onChangeCommitted onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture orientation placeholder prefix property radioGroup ref resource results role scale security slot spellCheck step style suppressContentEditableWarning suppressHydrationWarning tabIndex title track translate typeof unselectable value valueLabelDisplay valueLabelFormat vocab Methods # onChange Properties # ThumbComponent # \u2022 Optional ThumbComponent : ElementType > Inherited from # Omit.ThumbComponent ValueLabelComponent # \u2022 Optional ValueLabelComponent : ElementType Inherited from # Omit.ValueLabelComponent about # \u2022 Optional about : string Inherited from # Omit.about accessKey # \u2022 Optional accessKey : string Inherited from # Omit.accessKey aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # Omit.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # Omit.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # Omit.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # Omit.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # Omit.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # Omit.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # Omit.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # Omit.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # Omit.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # Omit.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # Omit.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # Omit.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # Omit.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # Omit.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # Omit.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # Omit.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # Omit.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # Omit.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # Omit.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # Omit.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # Omit.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # Omit.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Inherited from # Omit.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Inherited from # Omit.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # Omit.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # Omit.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # Omit.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # Omit.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # Omit.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # Omit.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # Omit.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # Omit.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # Omit.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # Omit.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # Omit.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # Omit.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # Omit.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # Omit.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # Omit.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # Omit.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # Omit.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # Omit.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # Omit.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # Omit.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # Omit.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # Omit.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # Omit.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Inherited from # Omit.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # Omit.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # Omit.autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # Omit.autoSave children # \u2022 Optional children : ReactNode Inherited from # Omit.children className # \u2022 Optional className : string Overrides # Omit.className classes # \u2022 Optional classes : Partial > Override or extend the styles applied to the component. Inherited from # Omit.classes color # \u2022 Optional color : \"primary\" | \"secondary\" Inherited from # Omit.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # Omit.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # Omit.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # Omit.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # Omit.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # Omit.defaultChecked defaultValue # \u2022 Optional defaultValue : number & number & readonly string [] & number [] & string & number [] & number & number [] & readonly string [] Inherited from # Omit.defaultValue dir # \u2022 Optional dir : string Inherited from # Omit.dir disabled # \u2022 Optional disabled : boolean Inherited from # Omit.disabled draggable # \u2022 Optional draggable : Booleanish Inherited from # Omit.draggable getAriaLabel # \u2022 Optional getAriaLabel : ( index : number ) => string Type declaration # \u25b8 ( index ): string Parameters # Name Type index number Returns # string Inherited from # Omit.getAriaLabel getAriaValueText # \u2022 Optional getAriaValueText : ( value : number , index : number ) => string Type declaration # \u25b8 ( value , index ): string Parameters # Name Type value number index number Returns # string Inherited from # Omit.getAriaValueText hidden # \u2022 Optional hidden : boolean Inherited from # Omit.hidden id # \u2022 Optional id : string Inherited from # Omit.id inlist # \u2022 Optional inlist : any Inherited from # Omit.inlist innerRef # \u2022 Optional innerRef : Ref Inherited from # Omit.innerRef inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # Omit.inputMode is # \u2022 Optional is : string 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 Inherited from # Omit.is itemID # \u2022 Optional itemID : string Inherited from # Omit.itemID itemProp # \u2022 Optional itemProp : string Inherited from # Omit.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # Omit.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # Omit.itemScope itemType # \u2022 Optional itemType : string Inherited from # Omit.itemType key # \u2022 Optional key : Key Inherited from # Omit.key lang # \u2022 Optional lang : string Inherited from # Omit.lang marks # \u2022 Optional marks : boolean | Mark [] Inherited from # Omit.marks max # \u2022 Optional max : number Inherited from # Omit.max min # \u2022 Optional min : number Inherited from # Omit.min name # \u2022 Optional name : string Inherited from # Omit.name onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # Omit.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # Omit.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # Omit.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # Omit.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # Omit.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # Omit.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # Omit.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # Omit.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # Omit.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # Omit.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # Omit.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # Omit.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # Omit.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # Omit.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # Omit.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # Omit.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # Omit.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # Omit.onCanPlayThroughCapture onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # Omit.onChangeCapture onChangeCommitted # \u2022 Optional onChangeCommitted : ( event : ChangeEvent < Object >, value : number | number []) => void Type declaration # \u25b8 ( event , value ): void Parameters # Name Type event ChangeEvent < Object > value number | number [] Returns # void Inherited from # Omit.onChangeCommitted onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # Omit.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # Omit.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # Omit.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # Omit.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # Omit.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # Omit.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # Omit.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # Omit.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # Omit.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # Omit.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # Omit.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # Omit.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # Omit.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # Omit.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # Omit.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # Omit.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # Omit.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # Omit.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # Omit.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # Omit.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # Omit.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # Omit.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # Omit.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # Omit.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # Omit.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # Omit.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # Omit.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # Omit.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # Omit.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # Omit.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # Omit.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # Omit.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # Omit.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # Omit.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # Omit.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # Omit.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # Omit.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # Omit.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # Omit.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # Omit.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # Omit.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # Omit.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # Omit.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # Omit.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # Omit.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # Omit.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # Omit.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # Omit.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # Omit.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # Omit.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # Omit.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # Omit.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # Omit.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # Omit.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # Omit.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # Omit.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # Omit.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # Omit.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # Omit.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # Omit.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # Omit.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # Omit.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # Omit.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # Omit.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # Omit.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # Omit.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # Omit.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # Omit.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # Omit.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # Omit.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # Omit.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # Omit.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # Omit.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # Omit.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # Omit.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # Omit.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # Omit.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # Omit.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # Omit.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # Omit.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # Omit.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # Omit.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # Omit.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # Omit.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # Omit.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # Omit.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # Omit.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # Omit.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # Omit.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # Omit.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # Omit.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # Omit.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # Omit.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # Omit.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # Omit.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # Omit.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # Omit.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # Omit.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # Omit.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # Omit.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # Omit.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # Omit.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # Omit.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # Omit.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # Omit.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # Omit.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # Omit.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # Omit.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # Omit.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # Omit.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # Omit.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # Omit.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # Omit.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # Omit.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # Omit.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # Omit.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # Omit.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # Omit.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # Omit.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # Omit.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # Omit.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # Omit.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # Omit.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # Omit.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # Omit.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # Omit.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # Omit.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # Omit.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # Omit.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # Omit.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # Omit.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # Omit.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # Omit.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # Omit.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # Omit.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # Omit.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # Omit.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # Omit.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # Omit.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # Omit.onWheelCapture orientation # \u2022 Optional orientation : \"horizontal\" | \"vertical\" Inherited from # Omit.orientation placeholder # \u2022 Optional placeholder : string Inherited from # Omit.placeholder prefix # \u2022 Optional prefix : string Inherited from # Omit.prefix property # \u2022 Optional property : string Inherited from # Omit.property radioGroup # \u2022 Optional radioGroup : string Inherited from # Omit.radioGroup ref # \u2022 Optional ref : Ref Inherited from # Omit.ref resource # \u2022 Optional resource : string Inherited from # Omit.resource results # \u2022 Optional results : number Inherited from # Omit.results role # \u2022 Optional role : string Inherited from # Omit.role scale # \u2022 Optional scale : ( value : number ) => number Type declaration # \u25b8 ( value ): number Parameters # Name Type value number Returns # number Inherited from # Omit.scale security # \u2022 Optional security : string Inherited from # Omit.security slot # \u2022 Optional slot : string Inherited from # Omit.slot spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # Omit.spellCheck step # \u2022 Optional step : number Inherited from # Omit.step style # \u2022 Optional style : CSSProperties Inherited from # Omit.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # Omit.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # Omit.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # Omit.tabIndex title # \u2022 Optional title : string Inherited from # Omit.title track # \u2022 Optional track : false | \"normal\" | \"inverted\" Inherited from # Omit.track translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # Omit.translate typeof # \u2022 Optional typeof : string Inherited from # Omit.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # Omit.unselectable value # \u2022 Optional value : number | number [] Inherited from # Omit.value valueLabelDisplay # \u2022 Optional valueLabelDisplay : \"on\" | \"off\" | \"auto\" Inherited from # Omit.valueLabelDisplay valueLabelFormat # \u2022 Optional valueLabelFormat : string | ( value : number , index : number ) => ReactNode Inherited from # Omit.valueLabelFormat vocab # \u2022 Optional vocab : string Inherited from # Omit.vocab Methods # onChange # \u25b8 Optional onChange ( evt , value ): void Parameters # Name Type evt FormEvent value number Returns # void","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#interface-sliderprops","text":"Renderer . Component .SliderProps","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#hierarchy","text":"Omit \u21b3 SliderProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#properties","text":"ThumbComponent ValueLabelComponent about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className classes color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir disabled draggable getAriaLabel getAriaValueText hidden id inlist innerRef inputMode is itemID itemProp itemRef itemScope itemType key lang marks max min name onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChangeCapture onChangeCommitted onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture orientation placeholder prefix property radioGroup ref resource results role scale security slot spellCheck step style suppressContentEditableWarning suppressHydrationWarning tabIndex title track translate typeof unselectable value valueLabelDisplay valueLabelFormat vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#thumbcomponent","text":"\u2022 Optional ThumbComponent : ElementType >","title":"ThumbComponent"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#valuelabelcomponent","text":"\u2022 Optional ValueLabelComponent : ElementType ","title":"ValueLabelComponent"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-label","text":"\u2022 Optional aria-label : string","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#classes","text":"\u2022 Optional classes : Partial > Override or extend the styles applied to the component.","title":"classes"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#color","text":"\u2022 Optional color : \"primary\" | \"secondary\"","title":"color"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#defaultvalue","text":"\u2022 Optional defaultValue : number & number & readonly string [] & number [] & string & number [] & number & number [] & readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#getarialabel","text":"\u2022 Optional getAriaLabel : ( index : number ) => string","title":"getAriaLabel"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#getariavaluetext","text":"\u2022 Optional getAriaValueText : ( value : number , index : number ) => string","title":"getAriaValueText"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#innerref","text":"\u2022 Optional innerRef : Ref ","title":"innerRef"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#key","text":"\u2022 Optional key : Key","title":"key"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#marks","text":"\u2022 Optional marks : boolean | Mark []","title":"marks"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#max","text":"\u2022 Optional max : number","title":"max"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#min","text":"\u2022 Optional min : number","title":"min"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onchangecommitted","text":"\u2022 Optional onChangeCommitted : ( event : ChangeEvent < Object >, value : number | number []) => void","title":"onChangeCommitted"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#orientation","text":"\u2022 Optional orientation : \"horizontal\" | \"vertical\"","title":"orientation"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#ref","text":"\u2022 Optional ref : Ref ","title":"ref"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#scale","text":"\u2022 Optional scale : ( value : number ) => number","title":"scale"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#track","text":"\u2022 Optional track : false | \"normal\" | \"inverted\"","title":"track"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#value","text":"\u2022 Optional value : number | number []","title":"value"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#valuelabeldisplay","text":"\u2022 Optional valueLabelDisplay : \"on\" | \"off\" | \"auto\"","title":"valueLabelDisplay"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#valuelabelformat","text":"\u2022 Optional valueLabelFormat : string | ( value : number , index : number ) => ReactNode","title":"valueLabelFormat"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.sliderprops/#onchange","text":"\u25b8 Optional onChange ( evt , value ): void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/","text":"Interface: SpinnerProps # Renderer . Component .SpinnerProps Hierarchy # HTMLProps \u21b3 SpinnerProps Table of contents # Properties # about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing center challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape singleColor size sizes slot span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap Properties # about # \u2022 Optional about : string Inherited from # React.HTMLProps.about accept # \u2022 Optional accept : string Inherited from # React.HTMLProps.accept acceptCharset # \u2022 Optional acceptCharset : string Inherited from # React.HTMLProps.acceptCharset accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLProps.accessKey action # \u2022 Optional action : string Inherited from # React.HTMLProps.action allowFullScreen # \u2022 Optional allowFullScreen : boolean Inherited from # React.HTMLProps.allowFullScreen allowTransparency # \u2022 Optional allowTransparency : boolean Inherited from # React.HTMLProps.allowTransparency alt # \u2022 Optional alt : string Inherited from # React.HTMLProps.alt aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLProps.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLProps.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLProps.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLProps.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLProps.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLProps.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLProps.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLProps.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLProps.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLProps.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLProps.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLProps.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLProps.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLProps.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLProps.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLProps.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLProps.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLProps.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLProps.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLProps.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLProps.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLProps.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLProps.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLProps.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLProps.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLProps.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLProps.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLProps.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLProps.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLProps.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLProps.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLProps.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLProps.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLProps.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLProps.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLProps.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLProps.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLProps.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLProps.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLProps.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLProps.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLProps.aria-valuetext as # \u2022 Optional as : string Inherited from # React.HTMLProps.as async # \u2022 Optional async : boolean Inherited from # React.HTMLProps.async autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLProps.autoCapitalize autoComplete # \u2022 Optional autoComplete : string Inherited from # React.HTMLProps.autoComplete autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLProps.autoCorrect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # React.HTMLProps.autoFocus autoPlay # \u2022 Optional autoPlay : boolean Inherited from # React.HTMLProps.autoPlay autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLProps.autoSave capture # \u2022 Optional capture : string | boolean Inherited from # React.HTMLProps.capture cellPadding # \u2022 Optional cellPadding : string | number Inherited from # React.HTMLProps.cellPadding cellSpacing # \u2022 Optional cellSpacing : string | number Inherited from # React.HTMLProps.cellSpacing center # \u2022 Optional center : boolean challenge # \u2022 Optional challenge : string Inherited from # React.HTMLProps.challenge charSet # \u2022 Optional charSet : string Inherited from # React.HTMLProps.charSet checked # \u2022 Optional checked : boolean Inherited from # React.HTMLProps.checked children # \u2022 Optional children : ReactNode Inherited from # React.HTMLProps.children cite # \u2022 Optional cite : string Inherited from # React.HTMLProps.cite classID # \u2022 Optional classID : string Inherited from # React.HTMLProps.classID className # \u2022 Optional className : string Inherited from # React.HTMLProps.className colSpan # \u2022 Optional colSpan : number Inherited from # React.HTMLProps.colSpan color # \u2022 Optional color : string Inherited from # React.HTMLProps.color cols # \u2022 Optional cols : number Inherited from # React.HTMLProps.cols content # \u2022 Optional content : string Inherited from # React.HTMLProps.content contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLProps.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLProps.contextMenu controls # \u2022 Optional controls : boolean Inherited from # React.HTMLProps.controls coords # \u2022 Optional coords : string Inherited from # React.HTMLProps.coords crossOrigin # \u2022 Optional crossOrigin : string Inherited from # React.HTMLProps.crossOrigin dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLProps.dangerouslySetInnerHTML data # \u2022 Optional data : string Inherited from # React.HTMLProps.data datatype # \u2022 Optional datatype : string Inherited from # React.HTMLProps.datatype dateTime # \u2022 Optional dateTime : string Inherited from # React.HTMLProps.dateTime default # \u2022 Optional default : boolean Inherited from # React.HTMLProps.default defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLProps.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLProps.defaultValue defer # \u2022 Optional defer : boolean Inherited from # React.HTMLProps.defer dir # \u2022 Optional dir : string Inherited from # React.HTMLProps.dir disabled # \u2022 Optional disabled : boolean Inherited from # React.HTMLProps.disabled download # \u2022 Optional download : any Inherited from # React.HTMLProps.download draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLProps.draggable encType # \u2022 Optional encType : string Inherited from # React.HTMLProps.encType form # \u2022 Optional form : string Inherited from # React.HTMLProps.form formAction # \u2022 Optional formAction : string Inherited from # React.HTMLProps.formAction formEncType # \u2022 Optional formEncType : string Inherited from # React.HTMLProps.formEncType formMethod # \u2022 Optional formMethod : string Inherited from # React.HTMLProps.formMethod formNoValidate # \u2022 Optional formNoValidate : boolean Inherited from # React.HTMLProps.formNoValidate formTarget # \u2022 Optional formTarget : string Inherited from # React.HTMLProps.formTarget frameBorder # \u2022 Optional frameBorder : string | number Inherited from # React.HTMLProps.frameBorder headers # \u2022 Optional headers : string Inherited from # React.HTMLProps.headers height # \u2022 Optional height : string | number Inherited from # React.HTMLProps.height hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLProps.hidden high # \u2022 Optional high : number Inherited from # React.HTMLProps.high href # \u2022 Optional href : string Inherited from # React.HTMLProps.href hrefLang # \u2022 Optional hrefLang : string Inherited from # React.HTMLProps.hrefLang htmlFor # \u2022 Optional htmlFor : string Inherited from # React.HTMLProps.htmlFor httpEquiv # \u2022 Optional httpEquiv : string Inherited from # React.HTMLProps.httpEquiv id # \u2022 Optional id : string Inherited from # React.HTMLProps.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLProps.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLProps.inputMode integrity # \u2022 Optional integrity : string Inherited from # React.HTMLProps.integrity is # \u2022 Optional is : string 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 Inherited from # React.HTMLProps.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLProps.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLProps.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLProps.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLProps.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLProps.itemType key # \u2022 Optional key : Key Inherited from # React.HTMLProps.key keyParams # \u2022 Optional keyParams : string Inherited from # React.HTMLProps.keyParams keyType # \u2022 Optional keyType : string Inherited from # React.HTMLProps.keyType kind # \u2022 Optional kind : string Inherited from # React.HTMLProps.kind label # \u2022 Optional label : string Inherited from # React.HTMLProps.label lang # \u2022 Optional lang : string Inherited from # React.HTMLProps.lang list # \u2022 Optional list : string Inherited from # React.HTMLProps.list loop # \u2022 Optional loop : boolean Inherited from # React.HTMLProps.loop low # \u2022 Optional low : number Inherited from # React.HTMLProps.low manifest # \u2022 Optional manifest : string Inherited from # React.HTMLProps.manifest marginHeight # \u2022 Optional marginHeight : number Inherited from # React.HTMLProps.marginHeight marginWidth # \u2022 Optional marginWidth : number Inherited from # React.HTMLProps.marginWidth max # \u2022 Optional max : string | number Inherited from # React.HTMLProps.max maxLength # \u2022 Optional maxLength : number Inherited from # React.HTMLProps.maxLength media # \u2022 Optional media : string Inherited from # React.HTMLProps.media mediaGroup # \u2022 Optional mediaGroup : string Inherited from # React.HTMLProps.mediaGroup method # \u2022 Optional method : string Inherited from # React.HTMLProps.method min # \u2022 Optional min : string | number Inherited from # React.HTMLProps.min minLength # \u2022 Optional minLength : number Inherited from # React.HTMLProps.minLength multiple # \u2022 Optional multiple : boolean Inherited from # React.HTMLProps.multiple muted # \u2022 Optional muted : boolean Inherited from # React.HTMLProps.muted name # \u2022 Optional name : string Inherited from # React.HTMLProps.name noValidate # \u2022 Optional noValidate : boolean Inherited from # React.HTMLProps.noValidate nonce # \u2022 Optional nonce : string Inherited from # React.HTMLProps.nonce onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLProps.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLProps.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLProps.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLProps.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLProps.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLProps.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLProps.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLProps.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLProps.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLProps.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLProps.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLProps.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLProps.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLProps.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLProps.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLProps.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLProps.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLProps.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLProps.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLProps.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLProps.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLProps.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLProps.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLProps.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLProps.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLProps.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLProps.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLProps.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLProps.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLProps.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLProps.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLProps.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLProps.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLProps.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLProps.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLProps.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLProps.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLProps.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLProps.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLProps.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLProps.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLProps.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLProps.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLProps.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLProps.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLProps.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLProps.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLProps.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLProps.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLProps.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLProps.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLProps.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLProps.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLProps.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLProps.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLProps.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLProps.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLProps.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLProps.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLProps.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLProps.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLProps.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLProps.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLProps.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLProps.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLProps.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLProps.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLProps.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLProps.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLProps.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLProps.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLProps.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLProps.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLProps.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLProps.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLProps.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLProps.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLProps.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLProps.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLProps.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLProps.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLProps.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLProps.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLProps.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLProps.onWheelCapture open # \u2022 Optional open : boolean Inherited from # React.HTMLProps.open optimum # \u2022 Optional optimum : number Inherited from # React.HTMLProps.optimum pattern # \u2022 Optional pattern : string Inherited from # React.HTMLProps.pattern placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLProps.placeholder playsInline # \u2022 Optional playsInline : boolean Inherited from # React.HTMLProps.playsInline poster # \u2022 Optional poster : string Inherited from # React.HTMLProps.poster prefix # \u2022 Optional prefix : string Inherited from # React.HTMLProps.prefix preload # \u2022 Optional preload : string Inherited from # React.HTMLProps.preload property # \u2022 Optional property : string Inherited from # React.HTMLProps.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLProps.radioGroup readOnly # \u2022 Optional readOnly : boolean Inherited from # React.HTMLProps.readOnly ref # \u2022 Optional ref : LegacyRef Inherited from # React.HTMLProps.ref rel # \u2022 Optional rel : string Inherited from # React.HTMLProps.rel required # \u2022 Optional required : boolean Inherited from # React.HTMLProps.required resource # \u2022 Optional resource : string Inherited from # React.HTMLProps.resource results # \u2022 Optional results : number Inherited from # React.HTMLProps.results reversed # \u2022 Optional reversed : boolean Inherited from # React.HTMLProps.reversed role # \u2022 Optional role : string Inherited from # React.HTMLProps.role rowSpan # \u2022 Optional rowSpan : number Inherited from # React.HTMLProps.rowSpan rows # \u2022 Optional rows : number Inherited from # React.HTMLProps.rows sandbox # \u2022 Optional sandbox : string Inherited from # React.HTMLProps.sandbox scope # \u2022 Optional scope : string Inherited from # React.HTMLProps.scope scoped # \u2022 Optional scoped : boolean Inherited from # React.HTMLProps.scoped scrolling # \u2022 Optional scrolling : string Inherited from # React.HTMLProps.scrolling seamless # \u2022 Optional seamless : boolean Inherited from # React.HTMLProps.seamless security # \u2022 Optional security : string Inherited from # React.HTMLProps.security selected # \u2022 Optional selected : boolean Inherited from # React.HTMLProps.selected shape # \u2022 Optional shape : string Inherited from # React.HTMLProps.shape singleColor # \u2022 Optional singleColor : boolean size # \u2022 Optional size : number Inherited from # React.HTMLProps.size sizes # \u2022 Optional sizes : string Inherited from # React.HTMLProps.sizes slot # \u2022 Optional slot : string Inherited from # React.HTMLProps.slot span # \u2022 Optional span : number Inherited from # React.HTMLProps.span spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLProps.spellCheck src # \u2022 Optional src : string Inherited from # React.HTMLProps.src srcDoc # \u2022 Optional srcDoc : string Inherited from # React.HTMLProps.srcDoc srcLang # \u2022 Optional srcLang : string Inherited from # React.HTMLProps.srcLang srcSet # \u2022 Optional srcSet : string Inherited from # React.HTMLProps.srcSet start # \u2022 Optional start : number Inherited from # React.HTMLProps.start step # \u2022 Optional step : string | number Inherited from # React.HTMLProps.step style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLProps.style summary # \u2022 Optional summary : string Inherited from # React.HTMLProps.summary suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLProps.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLProps.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLProps.tabIndex target # \u2022 Optional target : string Inherited from # React.HTMLProps.target title # \u2022 Optional title : string Inherited from # React.HTMLProps.title translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLProps.translate type # \u2022 Optional type : string Inherited from # React.HTMLProps.type typeof # \u2022 Optional typeof : string Inherited from # React.HTMLProps.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLProps.unselectable useMap # \u2022 Optional useMap : string Inherited from # React.HTMLProps.useMap value # \u2022 Optional value : string | number | readonly string [] Inherited from # React.HTMLProps.value vocab # \u2022 Optional vocab : string Inherited from # React.HTMLProps.vocab width # \u2022 Optional width : string | number Inherited from # React.HTMLProps.width wmode # \u2022 Optional wmode : string Inherited from # React.HTMLProps.wmode wrap # \u2022 Optional wrap : string Inherited from # React.HTMLProps.wrap","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#interface-spinnerprops","text":"Renderer . Component .SpinnerProps","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#hierarchy","text":"HTMLProps \u21b3 SpinnerProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#properties","text":"about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing center challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape singleColor size sizes slot span spellCheck src srcDoc srcLang srcSet start step style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#accept","text":"\u2022 Optional accept : string","title":"accept"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#acceptcharset","text":"\u2022 Optional acceptCharset : string","title":"acceptCharset"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#allowfullscreen","text":"\u2022 Optional allowFullScreen : boolean","title":"allowFullScreen"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#allowtransparency","text":"\u2022 Optional allowTransparency : boolean","title":"allowTransparency"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#alt","text":"\u2022 Optional alt : string","title":"alt"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#as","text":"\u2022 Optional as : string","title":"as"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#async","text":"\u2022 Optional async : boolean","title":"async"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autocomplete","text":"\u2022 Optional autoComplete : string","title":"autoComplete"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autoplay","text":"\u2022 Optional autoPlay : boolean","title":"autoPlay"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#capture","text":"\u2022 Optional capture : string | boolean","title":"capture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#cellpadding","text":"\u2022 Optional cellPadding : string | number","title":"cellPadding"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#cellspacing","text":"\u2022 Optional cellSpacing : string | number","title":"cellSpacing"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#challenge","text":"\u2022 Optional challenge : string","title":"challenge"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#charset","text":"\u2022 Optional charSet : string","title":"charSet"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#cite","text":"\u2022 Optional cite : string","title":"cite"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#classid","text":"\u2022 Optional classID : string","title":"classID"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#colspan","text":"\u2022 Optional colSpan : number","title":"colSpan"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#cols","text":"\u2022 Optional cols : number","title":"cols"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#content","text":"\u2022 Optional content : string","title":"content"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#controls","text":"\u2022 Optional controls : boolean","title":"controls"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#coords","text":"\u2022 Optional coords : string","title":"coords"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#crossorigin","text":"\u2022 Optional crossOrigin : string","title":"crossOrigin"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#data","text":"\u2022 Optional data : string","title":"data"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#datetime","text":"\u2022 Optional dateTime : string","title":"dateTime"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#defer","text":"\u2022 Optional defer : boolean","title":"defer"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#download","text":"\u2022 Optional download : any","title":"download"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#enctype","text":"\u2022 Optional encType : string","title":"encType"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#form","text":"\u2022 Optional form : string","title":"form"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#formaction","text":"\u2022 Optional formAction : string","title":"formAction"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#formenctype","text":"\u2022 Optional formEncType : string","title":"formEncType"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#formmethod","text":"\u2022 Optional formMethod : string","title":"formMethod"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#formnovalidate","text":"\u2022 Optional formNoValidate : boolean","title":"formNoValidate"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#formtarget","text":"\u2022 Optional formTarget : string","title":"formTarget"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#frameborder","text":"\u2022 Optional frameBorder : string | number","title":"frameBorder"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#headers","text":"\u2022 Optional headers : string","title":"headers"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#high","text":"\u2022 Optional high : number","title":"high"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#hreflang","text":"\u2022 Optional hrefLang : string","title":"hrefLang"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#httpequiv","text":"\u2022 Optional httpEquiv : string","title":"httpEquiv"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#integrity","text":"\u2022 Optional integrity : string","title":"integrity"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#key","text":"\u2022 Optional key : Key","title":"key"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#keyparams","text":"\u2022 Optional keyParams : string","title":"keyParams"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#keytype","text":"\u2022 Optional keyType : string","title":"keyType"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#kind","text":"\u2022 Optional kind : string","title":"kind"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#label","text":"\u2022 Optional label : string","title":"label"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#list","text":"\u2022 Optional list : string","title":"list"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#loop","text":"\u2022 Optional loop : boolean","title":"loop"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#low","text":"\u2022 Optional low : number","title":"low"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#manifest","text":"\u2022 Optional manifest : string","title":"manifest"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#marginheight","text":"\u2022 Optional marginHeight : number","title":"marginHeight"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#marginwidth","text":"\u2022 Optional marginWidth : number","title":"marginWidth"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#max","text":"\u2022 Optional max : string | number","title":"max"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#maxlength","text":"\u2022 Optional maxLength : number","title":"maxLength"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#media","text":"\u2022 Optional media : string","title":"media"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#mediagroup","text":"\u2022 Optional mediaGroup : string","title":"mediaGroup"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#method","text":"\u2022 Optional method : string","title":"method"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#min","text":"\u2022 Optional min : string | number","title":"min"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#minlength","text":"\u2022 Optional minLength : number","title":"minLength"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#multiple","text":"\u2022 Optional multiple : boolean","title":"multiple"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#muted","text":"\u2022 Optional muted : boolean","title":"muted"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#nonce","text":"\u2022 Optional nonce : string","title":"nonce"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#open","text":"\u2022 Optional open : boolean","title":"open"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#optimum","text":"\u2022 Optional optimum : number","title":"optimum"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#pattern","text":"\u2022 Optional pattern : string","title":"pattern"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#playsinline","text":"\u2022 Optional playsInline : boolean","title":"playsInline"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#poster","text":"\u2022 Optional poster : string","title":"poster"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#preload","text":"\u2022 Optional preload : string","title":"preload"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#ref","text":"\u2022 Optional ref : LegacyRef ","title":"ref"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#rel","text":"\u2022 Optional rel : string","title":"rel"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#required","text":"\u2022 Optional required : boolean","title":"required"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#reversed","text":"\u2022 Optional reversed : boolean","title":"reversed"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#rowspan","text":"\u2022 Optional rowSpan : number","title":"rowSpan"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#rows","text":"\u2022 Optional rows : number","title":"rows"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#sandbox","text":"\u2022 Optional sandbox : string","title":"sandbox"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#scope","text":"\u2022 Optional scope : string","title":"scope"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#scoped","text":"\u2022 Optional scoped : boolean","title":"scoped"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#scrolling","text":"\u2022 Optional scrolling : string","title":"scrolling"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#seamless","text":"\u2022 Optional seamless : boolean","title":"seamless"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#shape","text":"\u2022 Optional shape : string","title":"shape"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#singlecolor","text":"\u2022 Optional singleColor : boolean","title":"singleColor"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#size","text":"\u2022 Optional size : number","title":"size"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#sizes","text":"\u2022 Optional sizes : string","title":"sizes"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#span","text":"\u2022 Optional span : number","title":"span"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#src","text":"\u2022 Optional src : string","title":"src"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#srcdoc","text":"\u2022 Optional srcDoc : string","title":"srcDoc"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#srclang","text":"\u2022 Optional srcLang : string","title":"srcLang"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#srcset","text":"\u2022 Optional srcSet : string","title":"srcSet"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#start","text":"\u2022 Optional start : number","title":"start"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#step","text":"\u2022 Optional step : string | number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#summary","text":"\u2022 Optional summary : string","title":"summary"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#target","text":"\u2022 Optional target : string","title":"target"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#usemap","text":"\u2022 Optional useMap : string","title":"useMap"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#value","text":"\u2022 Optional value : string | number | readonly string []","title":"value"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#wmode","text":"\u2022 Optional wmode : string","title":"wmode"},{"location":"extensions/api/interfaces/renderer.component.spinnerprops/#wrap","text":"\u2022 Optional wrap : string","title":"wrap"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/","text":"Interface: StatusBrickProps # Renderer . Component .StatusBrickProps Hierarchy # HTMLAttributes TooltipDecoratorProps \u21b3 StatusBrickProps Table of contents # Properties # about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType lang onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab Properties # about # \u2022 Optional about : string Inherited from # React.HTMLAttributes.about accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLAttributes.accessKey aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLAttributes.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLAttributes.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLAttributes.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLAttributes.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLAttributes.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLAttributes.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLAttributes.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLAttributes.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLAttributes.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLAttributes.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLAttributes.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLAttributes.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLAttributes.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLAttributes.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLAttributes.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLAttributes.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLAttributes.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLAttributes.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLAttributes.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLAttributes.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLAttributes.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLAttributes.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLAttributes.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLAttributes.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLAttributes.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLAttributes.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLAttributes.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLAttributes.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLAttributes.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLAttributes.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLAttributes.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLAttributes.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLAttributes.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLAttributes.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLAttributes.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLAttributes.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLAttributes.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLAttributes.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLAttributes.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLAttributes.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLAttributes.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLAttributes.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLAttributes.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLAttributes.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLAttributes.aria-valuetext autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLAttributes.autoCapitalize autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLAttributes.autoCorrect autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLAttributes.autoSave children # \u2022 Optional children : ReactNode Inherited from # React.HTMLAttributes.children className # \u2022 Optional className : string Inherited from # React.HTMLAttributes.className color # \u2022 Optional color : string Inherited from # React.HTMLAttributes.color contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLAttributes.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLAttributes.contextMenu dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLAttributes.dangerouslySetInnerHTML datatype # \u2022 Optional datatype : string Inherited from # React.HTMLAttributes.datatype defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLAttributes.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLAttributes.defaultValue dir # \u2022 Optional dir : string Inherited from # React.HTMLAttributes.dir draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLAttributes.draggable hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLAttributes.hidden id # \u2022 Optional id : string Inherited from # React.HTMLAttributes.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLAttributes.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLAttributes.inputMode is # \u2022 Optional is : string 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 Inherited from # React.HTMLAttributes.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLAttributes.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLAttributes.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLAttributes.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLAttributes.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLAttributes.itemType lang # \u2022 Optional lang : string Inherited from # React.HTMLAttributes.lang onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLAttributes.onWheelCapture placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLAttributes.placeholder prefix # \u2022 Optional prefix : string Inherited from # React.HTMLAttributes.prefix property # \u2022 Optional property : string Inherited from # React.HTMLAttributes.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLAttributes.radioGroup resource # \u2022 Optional resource : string Inherited from # React.HTMLAttributes.resource results # \u2022 Optional results : number Inherited from # React.HTMLAttributes.results role # \u2022 Optional role : string Inherited from # React.HTMLAttributes.role security # \u2022 Optional security : string Inherited from # React.HTMLAttributes.security slot # \u2022 Optional slot : string Inherited from # React.HTMLAttributes.slot spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLAttributes.spellCheck style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLAttributes.style suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLAttributes.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLAttributes.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLAttributes.tabIndex title # \u2022 Optional title : string Inherited from # React.HTMLAttributes.title tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > Inherited from # TooltipDecoratorProps . tooltip tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\" Inherited from # TooltipDecoratorProps . tooltipOverrideDisabled translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLAttributes.translate typeof # \u2022 Optional typeof : string Inherited from # React.HTMLAttributes.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLAttributes.unselectable vocab # \u2022 Optional vocab : string Inherited from # React.HTMLAttributes.vocab","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#interface-statusbrickprops","text":"Renderer . Component .StatusBrickProps","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#hierarchy","text":"HTMLAttributes TooltipDecoratorProps \u21b3 StatusBrickProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#properties","text":"about accessKey aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext autoCapitalize autoCorrect autoSave children className color contentEditable contextMenu dangerouslySetInnerHTML datatype defaultChecked defaultValue dir draggable hidden id inlist inputMode is itemID itemProp itemRef itemScope itemType lang onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture placeholder prefix property radioGroup resource results role security slot spellCheck style suppressContentEditableWarning suppressHydrationWarning tabIndex title tooltip tooltipOverrideDisabled translate typeof unselectable vocab","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.statusbrickprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/","text":"Interface: StepperProps # Renderer . Component .StepperProps Hierarchy # HTMLProps \u21b3 StepperProps Table of contents # Properties # about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot span spellCheck src srcDoc srcLang srcSet start step steps style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap Properties # about # \u2022 Optional about : string Inherited from # React.HTMLProps.about accept # \u2022 Optional accept : string Inherited from # React.HTMLProps.accept acceptCharset # \u2022 Optional acceptCharset : string Inherited from # React.HTMLProps.acceptCharset accessKey # \u2022 Optional accessKey : string Inherited from # React.HTMLProps.accessKey action # \u2022 Optional action : string Inherited from # React.HTMLProps.action allowFullScreen # \u2022 Optional allowFullScreen : boolean Inherited from # React.HTMLProps.allowFullScreen allowTransparency # \u2022 Optional allowTransparency : boolean Inherited from # React.HTMLProps.allowTransparency alt # \u2022 Optional alt : string Inherited from # React.HTMLProps.alt aria-activedescendant # \u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. Inherited from # React.HTMLProps.aria-activedescendant aria-atomic # \u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-atomic aria-autocomplete # \u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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. Inherited from # React.HTMLProps.aria-autocomplete aria-busy # \u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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. Inherited from # React.HTMLProps.aria-busy aria-checked # \u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected. Inherited from # React.HTMLProps.aria-checked aria-colcount # \u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex. Inherited from # React.HTMLProps.aria-colcount aria-colindex # \u2022 Optional aria-colindex : number 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. Inherited from # React.HTMLProps.aria-colindex aria-colspan # \u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan. Inherited from # React.HTMLProps.aria-colspan aria-controls # \u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns. Inherited from # React.HTMLProps.aria-controls aria-current # \u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements. Inherited from # React.HTMLProps.aria-current aria-describedby # \u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby Inherited from # React.HTMLProps.aria-describedby aria-details # \u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby. Inherited from # React.HTMLProps.aria-details aria-disabled # \u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly. Inherited from # React.HTMLProps.aria-disabled aria-dropeffect # \u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-dropeffect aria-errormessage # \u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby. Inherited from # React.HTMLProps.aria-errormessage aria-expanded # \u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. Inherited from # React.HTMLProps.aria-expanded aria-flowto # \u2022 Optional aria-flowto : string 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. Inherited from # React.HTMLProps.aria-flowto aria-grabbed # \u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1 Inherited from # React.HTMLProps.aria-grabbed aria-haspopup # \u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. Inherited from # React.HTMLProps.aria-haspopup aria-hidden # \u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled. Inherited from # React.HTMLProps.aria-hidden aria-invalid # \u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage. Inherited from # React.HTMLProps.aria-invalid aria-keyshortcuts # \u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Inherited from # React.HTMLProps.aria-keyshortcuts aria-label # \u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby. Inherited from # React.HTMLProps.aria-label aria-labelledby # \u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby. Inherited from # React.HTMLProps.aria-labelledby aria-level # \u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure. Inherited from # React.HTMLProps.aria-level aria-live # \u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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. Inherited from # React.HTMLProps.aria-live aria-modal # \u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed. Inherited from # React.HTMLProps.aria-modal aria-multiline # \u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line. Inherited from # React.HTMLProps.aria-multiline aria-multiselectable # \u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants. Inherited from # React.HTMLProps.aria-multiselectable aria-orientation # \u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Inherited from # React.HTMLProps.aria-orientation aria-owns # \u2022 Optional aria-owns : string 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. Inherited from # React.HTMLProps.aria-owns aria-placeholder # \u2022 Optional aria-placeholder : string 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. Inherited from # React.HTMLProps.aria-placeholder aria-posinset # \u2022 Optional aria-posinset : number 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. Inherited from # React.HTMLProps.aria-posinset aria-pressed # \u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected. Inherited from # React.HTMLProps.aria-pressed aria-readonly # \u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled. Inherited from # React.HTMLProps.aria-readonly aria-relevant # \u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic. Inherited from # React.HTMLProps.aria-relevant aria-required # \u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted. Inherited from # React.HTMLProps.aria-required aria-roledescription # \u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element. Inherited from # React.HTMLProps.aria-roledescription aria-rowcount # \u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex. Inherited from # React.HTMLProps.aria-rowcount aria-rowindex # \u2022 Optional aria-rowindex : number 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. Inherited from # React.HTMLProps.aria-rowindex aria-rowspan # \u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan. Inherited from # React.HTMLProps.aria-rowspan aria-selected # \u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed. Inherited from # React.HTMLProps.aria-selected aria-setsize # \u2022 Optional aria-setsize : number 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. Inherited from # React.HTMLProps.aria-setsize aria-sort # \u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order. Inherited from # React.HTMLProps.aria-sort aria-valuemax # \u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemax aria-valuemin # \u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget. Inherited from # React.HTMLProps.aria-valuemin aria-valuenow # \u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext. Inherited from # React.HTMLProps.aria-valuenow aria-valuetext # \u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget. Inherited from # React.HTMLProps.aria-valuetext as # \u2022 Optional as : string Inherited from # React.HTMLProps.as async # \u2022 Optional async : boolean Inherited from # React.HTMLProps.async autoCapitalize # \u2022 Optional autoCapitalize : string Inherited from # React.HTMLProps.autoCapitalize autoComplete # \u2022 Optional autoComplete : string Inherited from # React.HTMLProps.autoComplete autoCorrect # \u2022 Optional autoCorrect : string Inherited from # React.HTMLProps.autoCorrect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # React.HTMLProps.autoFocus autoPlay # \u2022 Optional autoPlay : boolean Inherited from # React.HTMLProps.autoPlay autoSave # \u2022 Optional autoSave : string Inherited from # React.HTMLProps.autoSave capture # \u2022 Optional capture : string | boolean Inherited from # React.HTMLProps.capture cellPadding # \u2022 Optional cellPadding : string | number Inherited from # React.HTMLProps.cellPadding cellSpacing # \u2022 Optional cellSpacing : string | number Inherited from # React.HTMLProps.cellSpacing challenge # \u2022 Optional challenge : string Inherited from # React.HTMLProps.challenge charSet # \u2022 Optional charSet : string Inherited from # React.HTMLProps.charSet checked # \u2022 Optional checked : boolean Inherited from # React.HTMLProps.checked children # \u2022 Optional children : ReactNode Inherited from # React.HTMLProps.children cite # \u2022 Optional cite : string Inherited from # React.HTMLProps.cite classID # \u2022 Optional classID : string Inherited from # React.HTMLProps.classID className # \u2022 Optional className : string Inherited from # React.HTMLProps.className colSpan # \u2022 Optional colSpan : number Inherited from # React.HTMLProps.colSpan color # \u2022 Optional color : string Inherited from # React.HTMLProps.color cols # \u2022 Optional cols : number Inherited from # React.HTMLProps.cols content # \u2022 Optional content : string Inherited from # React.HTMLProps.content contentEditable # \u2022 Optional contentEditable : Booleanish | \"inherit\" Inherited from # React.HTMLProps.contentEditable contextMenu # \u2022 Optional contextMenu : string Inherited from # React.HTMLProps.contextMenu controls # \u2022 Optional controls : boolean Inherited from # React.HTMLProps.controls coords # \u2022 Optional coords : string Inherited from # React.HTMLProps.coords crossOrigin # \u2022 Optional crossOrigin : string Inherited from # React.HTMLProps.crossOrigin dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.HTMLProps.dangerouslySetInnerHTML data # \u2022 Optional data : string Inherited from # React.HTMLProps.data datatype # \u2022 Optional datatype : string Inherited from # React.HTMLProps.datatype dateTime # \u2022 Optional dateTime : string Inherited from # React.HTMLProps.dateTime default # \u2022 Optional default : boolean Inherited from # React.HTMLProps.default defaultChecked # \u2022 Optional defaultChecked : boolean Inherited from # React.HTMLProps.defaultChecked defaultValue # \u2022 Optional defaultValue : string | number | readonly string [] Inherited from # React.HTMLProps.defaultValue defer # \u2022 Optional defer : boolean Inherited from # React.HTMLProps.defer dir # \u2022 Optional dir : string Inherited from # React.HTMLProps.dir disabled # \u2022 Optional disabled : boolean Inherited from # React.HTMLProps.disabled download # \u2022 Optional download : any Inherited from # React.HTMLProps.download draggable # \u2022 Optional draggable : Booleanish Inherited from # React.HTMLProps.draggable encType # \u2022 Optional encType : string Inherited from # React.HTMLProps.encType form # \u2022 Optional form : string Inherited from # React.HTMLProps.form formAction # \u2022 Optional formAction : string Inherited from # React.HTMLProps.formAction formEncType # \u2022 Optional formEncType : string Inherited from # React.HTMLProps.formEncType formMethod # \u2022 Optional formMethod : string Inherited from # React.HTMLProps.formMethod formNoValidate # \u2022 Optional formNoValidate : boolean Inherited from # React.HTMLProps.formNoValidate formTarget # \u2022 Optional formTarget : string Inherited from # React.HTMLProps.formTarget frameBorder # \u2022 Optional frameBorder : string | number Inherited from # React.HTMLProps.frameBorder headers # \u2022 Optional headers : string Inherited from # React.HTMLProps.headers height # \u2022 Optional height : string | number Inherited from # React.HTMLProps.height hidden # \u2022 Optional hidden : boolean Inherited from # React.HTMLProps.hidden high # \u2022 Optional high : number Inherited from # React.HTMLProps.high href # \u2022 Optional href : string Inherited from # React.HTMLProps.href hrefLang # \u2022 Optional hrefLang : string Inherited from # React.HTMLProps.hrefLang htmlFor # \u2022 Optional htmlFor : string Inherited from # React.HTMLProps.htmlFor httpEquiv # \u2022 Optional httpEquiv : string Inherited from # React.HTMLProps.httpEquiv id # \u2022 Optional id : string Inherited from # React.HTMLProps.id inlist # \u2022 Optional inlist : any Inherited from # React.HTMLProps.inlist inputMode # \u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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 Inherited from # React.HTMLProps.inputMode integrity # \u2022 Optional integrity : string Inherited from # React.HTMLProps.integrity is # \u2022 Optional is : string 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 Inherited from # React.HTMLProps.is itemID # \u2022 Optional itemID : string Inherited from # React.HTMLProps.itemID itemProp # \u2022 Optional itemProp : string Inherited from # React.HTMLProps.itemProp itemRef # \u2022 Optional itemRef : string Inherited from # React.HTMLProps.itemRef itemScope # \u2022 Optional itemScope : boolean Inherited from # React.HTMLProps.itemScope itemType # \u2022 Optional itemType : string Inherited from # React.HTMLProps.itemType key # \u2022 Optional key : Key Inherited from # React.HTMLProps.key keyParams # \u2022 Optional keyParams : string Inherited from # React.HTMLProps.keyParams keyType # \u2022 Optional keyType : string Inherited from # React.HTMLProps.keyType kind # \u2022 Optional kind : string Inherited from # React.HTMLProps.kind label # \u2022 Optional label : string Inherited from # React.HTMLProps.label lang # \u2022 Optional lang : string Inherited from # React.HTMLProps.lang list # \u2022 Optional list : string Inherited from # React.HTMLProps.list loop # \u2022 Optional loop : boolean Inherited from # React.HTMLProps.loop low # \u2022 Optional low : number Inherited from # React.HTMLProps.low manifest # \u2022 Optional manifest : string Inherited from # React.HTMLProps.manifest marginHeight # \u2022 Optional marginHeight : number Inherited from # React.HTMLProps.marginHeight marginWidth # \u2022 Optional marginWidth : number Inherited from # React.HTMLProps.marginWidth max # \u2022 Optional max : string | number Inherited from # React.HTMLProps.max maxLength # \u2022 Optional maxLength : number Inherited from # React.HTMLProps.maxLength media # \u2022 Optional media : string Inherited from # React.HTMLProps.media mediaGroup # \u2022 Optional mediaGroup : string Inherited from # React.HTMLProps.mediaGroup method # \u2022 Optional method : string Inherited from # React.HTMLProps.method min # \u2022 Optional min : string | number Inherited from # React.HTMLProps.min minLength # \u2022 Optional minLength : number Inherited from # React.HTMLProps.minLength multiple # \u2022 Optional multiple : boolean Inherited from # React.HTMLProps.multiple muted # \u2022 Optional muted : boolean Inherited from # React.HTMLProps.muted name # \u2022 Optional name : string Inherited from # React.HTMLProps.name noValidate # \u2022 Optional noValidate : boolean Inherited from # React.HTMLProps.noValidate nonce # \u2022 Optional nonce : string Inherited from # React.HTMLProps.nonce onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.HTMLProps.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.HTMLProps.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.HTMLProps.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.HTMLProps.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.HTMLProps.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.HTMLProps.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.HTMLProps.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.HTMLProps.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.HTMLProps.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.HTMLProps.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.HTMLProps.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.HTMLProps.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.HTMLProps.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.HTMLProps.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.HTMLProps.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.HTMLProps.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.HTMLProps.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.HTMLProps.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.HTMLProps.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.HTMLProps.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.HTMLProps.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.HTMLProps.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.HTMLProps.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.HTMLProps.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.HTMLProps.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.HTMLProps.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.HTMLProps.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.HTMLProps.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.HTMLProps.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.HTMLProps.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.HTMLProps.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.HTMLProps.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.HTMLProps.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.HTMLProps.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.HTMLProps.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.HTMLProps.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.HTMLProps.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.HTMLProps.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.HTMLProps.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.HTMLProps.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.HTMLProps.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.HTMLProps.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.HTMLProps.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.HTMLProps.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.HTMLProps.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.HTMLProps.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.HTMLProps.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.HTMLProps.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.HTMLProps.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.HTMLProps.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.HTMLProps.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.HTMLProps.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.HTMLProps.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.HTMLProps.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.HTMLProps.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.HTMLProps.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.HTMLProps.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.HTMLProps.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.HTMLProps.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.HTMLProps.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.HTMLProps.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.HTMLProps.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.HTMLProps.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.HTMLProps.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.HTMLProps.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.HTMLProps.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.HTMLProps.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.HTMLProps.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.HTMLProps.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.HTMLProps.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.HTMLProps.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.HTMLProps.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.HTMLProps.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.HTMLProps.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.HTMLProps.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.HTMLProps.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.HTMLProps.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.HTMLProps.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.HTMLProps.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.HTMLProps.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.HTMLProps.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.HTMLProps.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.HTMLProps.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.HTMLProps.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.HTMLProps.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.HTMLProps.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.HTMLProps.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.HTMLProps.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.HTMLProps.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.HTMLProps.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.HTMLProps.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.HTMLProps.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.HTMLProps.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.HTMLProps.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.HTMLProps.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.HTMLProps.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.HTMLProps.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.HTMLProps.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.HTMLProps.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.HTMLProps.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.HTMLProps.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.HTMLProps.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.HTMLProps.onWheelCapture open # \u2022 Optional open : boolean Inherited from # React.HTMLProps.open optimum # \u2022 Optional optimum : number Inherited from # React.HTMLProps.optimum pattern # \u2022 Optional pattern : string Inherited from # React.HTMLProps.pattern placeholder # \u2022 Optional placeholder : string Inherited from # React.HTMLProps.placeholder playsInline # \u2022 Optional playsInline : boolean Inherited from # React.HTMLProps.playsInline poster # \u2022 Optional poster : string Inherited from # React.HTMLProps.poster prefix # \u2022 Optional prefix : string Inherited from # React.HTMLProps.prefix preload # \u2022 Optional preload : string Inherited from # React.HTMLProps.preload property # \u2022 Optional property : string Inherited from # React.HTMLProps.property radioGroup # \u2022 Optional radioGroup : string Inherited from # React.HTMLProps.radioGroup readOnly # \u2022 Optional readOnly : boolean Inherited from # React.HTMLProps.readOnly ref # \u2022 Optional ref : LegacyRef Inherited from # React.HTMLProps.ref rel # \u2022 Optional rel : string Inherited from # React.HTMLProps.rel required # \u2022 Optional required : boolean Inherited from # React.HTMLProps.required resource # \u2022 Optional resource : string Inherited from # React.HTMLProps.resource results # \u2022 Optional results : number Inherited from # React.HTMLProps.results reversed # \u2022 Optional reversed : boolean Inherited from # React.HTMLProps.reversed role # \u2022 Optional role : string Inherited from # React.HTMLProps.role rowSpan # \u2022 Optional rowSpan : number Inherited from # React.HTMLProps.rowSpan rows # \u2022 Optional rows : number Inherited from # React.HTMLProps.rows sandbox # \u2022 Optional sandbox : string Inherited from # React.HTMLProps.sandbox scope # \u2022 Optional scope : string Inherited from # React.HTMLProps.scope scoped # \u2022 Optional scoped : boolean Inherited from # React.HTMLProps.scoped scrolling # \u2022 Optional scrolling : string Inherited from # React.HTMLProps.scrolling seamless # \u2022 Optional seamless : boolean Inherited from # React.HTMLProps.seamless security # \u2022 Optional security : string Inherited from # React.HTMLProps.security selected # \u2022 Optional selected : boolean Inherited from # React.HTMLProps.selected shape # \u2022 Optional shape : string Inherited from # React.HTMLProps.shape size # \u2022 Optional size : number Inherited from # React.HTMLProps.size sizes # \u2022 Optional sizes : string Inherited from # React.HTMLProps.sizes slot # \u2022 Optional slot : string Inherited from # React.HTMLProps.slot span # \u2022 Optional span : number Inherited from # React.HTMLProps.span spellCheck # \u2022 Optional spellCheck : Booleanish Inherited from # React.HTMLProps.spellCheck src # \u2022 Optional src : string Inherited from # React.HTMLProps.src srcDoc # \u2022 Optional srcDoc : string Inherited from # React.HTMLProps.srcDoc srcLang # \u2022 Optional srcLang : string Inherited from # React.HTMLProps.srcLang srcSet # \u2022 Optional srcSet : string Inherited from # React.HTMLProps.srcSet start # \u2022 Optional start : number Inherited from # React.HTMLProps.start step # \u2022 step : number Overrides # React.HTMLProps.step steps # \u2022 steps : Step [] style # \u2022 Optional style : CSSProperties Inherited from # React.HTMLProps.style summary # \u2022 Optional summary : string Inherited from # React.HTMLProps.summary suppressContentEditableWarning # \u2022 Optional suppressContentEditableWarning : boolean Inherited from # React.HTMLProps.suppressContentEditableWarning suppressHydrationWarning # \u2022 Optional suppressHydrationWarning : boolean Inherited from # React.HTMLProps.suppressHydrationWarning tabIndex # \u2022 Optional tabIndex : number Inherited from # React.HTMLProps.tabIndex target # \u2022 Optional target : string Inherited from # React.HTMLProps.target title # \u2022 Optional title : string Inherited from # React.HTMLProps.title translate # \u2022 Optional translate : \"yes\" | \"no\" Inherited from # React.HTMLProps.translate type # \u2022 Optional type : string Inherited from # React.HTMLProps.type typeof # \u2022 Optional typeof : string Inherited from # React.HTMLProps.typeof unselectable # \u2022 Optional unselectable : \"on\" | \"off\" Inherited from # React.HTMLProps.unselectable useMap # \u2022 Optional useMap : string Inherited from # React.HTMLProps.useMap value # \u2022 Optional value : string | number | readonly string [] Inherited from # React.HTMLProps.value vocab # \u2022 Optional vocab : string Inherited from # React.HTMLProps.vocab width # \u2022 Optional width : string | number Inherited from # React.HTMLProps.width wmode # \u2022 Optional wmode : string Inherited from # React.HTMLProps.wmode wrap # \u2022 Optional wrap : string Inherited from # React.HTMLProps.wrap","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#interface-stepperprops","text":"Renderer . Component .StepperProps","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#hierarchy","text":"HTMLProps \u21b3 StepperProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#properties","text":"about accept acceptCharset accessKey action allowFullScreen allowTransparency alt aria-activedescendant aria-atomic aria-autocomplete aria-busy aria-checked aria-colcount aria-colindex aria-colspan aria-controls aria-current aria-describedby aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext as async autoCapitalize autoComplete autoCorrect autoFocus autoPlay autoSave capture cellPadding cellSpacing challenge charSet checked children cite classID className colSpan color cols content contentEditable contextMenu controls coords crossOrigin dangerouslySetInnerHTML data datatype dateTime default defaultChecked defaultValue defer dir disabled download draggable encType form formAction formEncType formMethod formNoValidate formTarget frameBorder headers height hidden high href hrefLang htmlFor httpEquiv id inlist inputMode integrity is itemID itemProp itemRef itemScope itemType key keyParams keyType kind label lang list loop low manifest marginHeight marginWidth max maxLength media mediaGroup method min minLength multiple muted name noValidate nonce onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture open optimum pattern placeholder playsInline poster prefix preload property radioGroup readOnly ref rel required resource results reversed role rowSpan rows sandbox scope scoped scrolling seamless security selected shape size sizes slot span spellCheck src srcDoc srcLang srcSet start step steps style summary suppressContentEditableWarning suppressHydrationWarning tabIndex target title translate type typeof unselectable useMap value vocab width wmode wrap","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#about","text":"\u2022 Optional about : string","title":"about"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#accept","text":"\u2022 Optional accept : string","title":"accept"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#acceptcharset","text":"\u2022 Optional acceptCharset : string","title":"acceptCharset"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#accesskey","text":"\u2022 Optional accessKey : string","title":"accessKey"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#allowfullscreen","text":"\u2022 Optional allowFullScreen : boolean","title":"allowFullScreen"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#allowtransparency","text":"\u2022 Optional allowTransparency : boolean","title":"allowTransparency"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#alt","text":"\u2022 Optional alt : string","title":"alt"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-activedescendant","text":"\u2022 Optional aria-activedescendant : string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.","title":"aria-activedescendant"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-atomic","text":"\u2022 Optional aria-atomic : boolean | \"true\" | \"false\" 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.","title":"aria-atomic"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-autocomplete","text":"\u2022 Optional aria-autocomplete : \"none\" | \"inline\" | \"list\" | \"both\" 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.","title":"aria-autocomplete"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-busy","text":"\u2022 Optional aria-busy : boolean | \"true\" | \"false\" 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.","title":"aria-busy"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-checked","text":"\u2022 Optional aria-checked : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets. see aria-pressed @see aria-selected.","title":"aria-checked"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-colcount","text":"\u2022 Optional aria-colcount : number Defines the total number of columns in a table, grid, or treegrid. see aria-colindex.","title":"aria-colcount"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-colindex","text":"\u2022 Optional aria-colindex : number 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.","title":"aria-colindex"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-colspan","text":"\u2022 Optional aria-colspan : number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. see aria-colindex @see aria-rowspan.","title":"aria-colspan"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-controls","text":"\u2022 Optional aria-controls : string Identifies the element (or elements) whose contents or presence are controlled by the current element. see aria-owns.","title":"aria-controls"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-current","text":"\u2022 Optional aria-current : boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" Indicates the element that represents the current item within a container or set of related elements.","title":"aria-current"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-describedby","text":"\u2022 Optional aria-describedby : string Identifies the element (or elements) that describes the object. see aria-labelledby","title":"aria-describedby"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-details","text":"\u2022 Optional aria-details : string Identifies the element that provides a detailed, extended description for the object. see aria-describedby.","title":"aria-details"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-disabled","text":"\u2022 Optional aria-disabled : boolean | \"true\" | \"false\" Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. see aria-hidden @see aria-readonly.","title":"aria-disabled"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-dropeffect","text":"\u2022 Optional aria-dropeffect : \"none\" | \"copy\" | \"execute\" | \"link\" | \"move\" | \"popup\" Indicates what functions can be performed when a dragged object is released on the drop target. deprecated in ARIA 1.1","title":"aria-dropeffect"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-errormessage","text":"\u2022 Optional aria-errormessage : string Identifies the element that provides an error message for the object. see aria-invalid @see aria-describedby.","title":"aria-errormessage"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-expanded","text":"\u2022 Optional aria-expanded : boolean | \"true\" | \"false\" Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.","title":"aria-expanded"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-flowto","text":"\u2022 Optional aria-flowto : string 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.","title":"aria-flowto"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-grabbed","text":"\u2022 Optional aria-grabbed : boolean | \"true\" | \"false\" Indicates an element's \"grabbed\" state in a drag-and-drop operation. deprecated in ARIA 1.1","title":"aria-grabbed"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-haspopup","text":"\u2022 Optional aria-haspopup : boolean | \"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.","title":"aria-haspopup"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-hidden","text":"\u2022 Optional aria-hidden : boolean | \"true\" | \"false\" Indicates whether the element is exposed to an accessibility API. see aria-disabled.","title":"aria-hidden"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-invalid","text":"\u2022 Optional aria-invalid : boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" Indicates the entered value does not conform to the format expected by the application. see aria-errormessage.","title":"aria-invalid"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-keyshortcuts","text":"\u2022 Optional aria-keyshortcuts : string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.","title":"aria-keyshortcuts"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-label","text":"\u2022 Optional aria-label : string Defines a string value that labels the current element. see aria-labelledby.","title":"aria-label"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-labelledby","text":"\u2022 Optional aria-labelledby : string Identifies the element (or elements) that labels the current element. see aria-describedby.","title":"aria-labelledby"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-level","text":"\u2022 Optional aria-level : number Defines the hierarchical level of an element within a structure.","title":"aria-level"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-live","text":"\u2022 Optional aria-live : \"off\" | \"assertive\" | \"polite\" 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.","title":"aria-live"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-modal","text":"\u2022 Optional aria-modal : boolean | \"true\" | \"false\" Indicates whether an element is modal when displayed.","title":"aria-modal"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-multiline","text":"\u2022 Optional aria-multiline : boolean | \"true\" | \"false\" Indicates whether a text box accepts multiple lines of input or only a single line.","title":"aria-multiline"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-multiselectable","text":"\u2022 Optional aria-multiselectable : boolean | \"true\" | \"false\" Indicates that the user may select more than one item from the current selectable descendants.","title":"aria-multiselectable"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-orientation","text":"\u2022 Optional aria-orientation : \"horizontal\" | \"vertical\" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.","title":"aria-orientation"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-owns","text":"\u2022 Optional aria-owns : string 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.","title":"aria-owns"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-placeholder","text":"\u2022 Optional aria-placeholder : string 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.","title":"aria-placeholder"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-posinset","text":"\u2022 Optional aria-posinset : number 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.","title":"aria-posinset"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-pressed","text":"\u2022 Optional aria-pressed : boolean | \"true\" | \"false\" | \"mixed\" Indicates the current \"pressed\" state of toggle buttons. see aria-checked @see aria-selected.","title":"aria-pressed"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-readonly","text":"\u2022 Optional aria-readonly : boolean | \"true\" | \"false\" Indicates that the element is not editable, but is otherwise operable. see aria-disabled.","title":"aria-readonly"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-relevant","text":"\u2022 Optional aria-relevant : \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"all\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. see aria-atomic.","title":"aria-relevant"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-required","text":"\u2022 Optional aria-required : boolean | \"true\" | \"false\" Indicates that user input is required on the element before a form may be submitted.","title":"aria-required"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-roledescription","text":"\u2022 Optional aria-roledescription : string Defines a human-readable, author-localized description for the role of an element.","title":"aria-roledescription"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-rowcount","text":"\u2022 Optional aria-rowcount : number Defines the total number of rows in a table, grid, or treegrid. see aria-rowindex.","title":"aria-rowcount"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-rowindex","text":"\u2022 Optional aria-rowindex : number 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.","title":"aria-rowindex"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-rowspan","text":"\u2022 Optional aria-rowspan : number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. see aria-rowindex @see aria-colspan.","title":"aria-rowspan"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-selected","text":"\u2022 Optional aria-selected : boolean | \"true\" | \"false\" Indicates the current \"selected\" state of various widgets. see aria-checked @see aria-pressed.","title":"aria-selected"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-setsize","text":"\u2022 Optional aria-setsize : number 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.","title":"aria-setsize"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-sort","text":"\u2022 Optional aria-sort : \"none\" | \"ascending\" | \"descending\" | \"other\" Indicates if items in a table or grid are sorted in ascending or descending order.","title":"aria-sort"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-valuemax","text":"\u2022 Optional aria-valuemax : number Defines the maximum allowed value for a range widget.","title":"aria-valuemax"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-valuemin","text":"\u2022 Optional aria-valuemin : number Defines the minimum allowed value for a range widget.","title":"aria-valuemin"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-valuenow","text":"\u2022 Optional aria-valuenow : number Defines the current value for a range widget. see aria-valuetext.","title":"aria-valuenow"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#aria-valuetext","text":"\u2022 Optional aria-valuetext : string Defines the human readable text alternative of aria-valuenow for a range widget.","title":"aria-valuetext"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#as","text":"\u2022 Optional as : string","title":"as"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#async","text":"\u2022 Optional async : boolean","title":"async"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autocapitalize","text":"\u2022 Optional autoCapitalize : string","title":"autoCapitalize"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autocomplete","text":"\u2022 Optional autoComplete : string","title":"autoComplete"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autocorrect","text":"\u2022 Optional autoCorrect : string","title":"autoCorrect"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autoplay","text":"\u2022 Optional autoPlay : boolean","title":"autoPlay"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#autosave","text":"\u2022 Optional autoSave : string","title":"autoSave"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#capture","text":"\u2022 Optional capture : string | boolean","title":"capture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#cellpadding","text":"\u2022 Optional cellPadding : string | number","title":"cellPadding"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#cellspacing","text":"\u2022 Optional cellSpacing : string | number","title":"cellSpacing"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#challenge","text":"\u2022 Optional challenge : string","title":"challenge"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#charset","text":"\u2022 Optional charSet : string","title":"charSet"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#cite","text":"\u2022 Optional cite : string","title":"cite"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#classid","text":"\u2022 Optional classID : string","title":"classID"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#colspan","text":"\u2022 Optional colSpan : number","title":"colSpan"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#color","text":"\u2022 Optional color : string","title":"color"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#cols","text":"\u2022 Optional cols : number","title":"cols"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#content","text":"\u2022 Optional content : string","title":"content"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#contenteditable","text":"\u2022 Optional contentEditable : Booleanish | \"inherit\"","title":"contentEditable"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#contextmenu","text":"\u2022 Optional contextMenu : string","title":"contextMenu"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#controls","text":"\u2022 Optional controls : boolean","title":"controls"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#coords","text":"\u2022 Optional coords : string","title":"coords"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#crossorigin","text":"\u2022 Optional crossOrigin : string","title":"crossOrigin"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#data","text":"\u2022 Optional data : string","title":"data"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#datatype","text":"\u2022 Optional datatype : string","title":"datatype"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#datetime","text":"\u2022 Optional dateTime : string","title":"dateTime"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#defaultchecked","text":"\u2022 Optional defaultChecked : boolean","title":"defaultChecked"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#defaultvalue","text":"\u2022 Optional defaultValue : string | number | readonly string []","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#defer","text":"\u2022 Optional defer : boolean","title":"defer"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#dir","text":"\u2022 Optional dir : string","title":"dir"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#download","text":"\u2022 Optional download : any","title":"download"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#draggable","text":"\u2022 Optional draggable : Booleanish","title":"draggable"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#enctype","text":"\u2022 Optional encType : string","title":"encType"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#form","text":"\u2022 Optional form : string","title":"form"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#formaction","text":"\u2022 Optional formAction : string","title":"formAction"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#formenctype","text":"\u2022 Optional formEncType : string","title":"formEncType"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#formmethod","text":"\u2022 Optional formMethod : string","title":"formMethod"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#formnovalidate","text":"\u2022 Optional formNoValidate : boolean","title":"formNoValidate"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#formtarget","text":"\u2022 Optional formTarget : string","title":"formTarget"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#frameborder","text":"\u2022 Optional frameBorder : string | number","title":"frameBorder"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#headers","text":"\u2022 Optional headers : string","title":"headers"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#high","text":"\u2022 Optional high : number","title":"high"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#hreflang","text":"\u2022 Optional hrefLang : string","title":"hrefLang"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#httpequiv","text":"\u2022 Optional httpEquiv : string","title":"httpEquiv"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#inlist","text":"\u2022 Optional inlist : any","title":"inlist"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#inputmode","text":"\u2022 Optional inputMode : \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | \"search\" 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","title":"inputMode"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#integrity","text":"\u2022 Optional integrity : string","title":"integrity"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#is","text":"\u2022 Optional is : string 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","title":"is"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#itemid","text":"\u2022 Optional itemID : string","title":"itemID"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#itemprop","text":"\u2022 Optional itemProp : string","title":"itemProp"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#itemref","text":"\u2022 Optional itemRef : string","title":"itemRef"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#itemscope","text":"\u2022 Optional itemScope : boolean","title":"itemScope"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#itemtype","text":"\u2022 Optional itemType : string","title":"itemType"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#key","text":"\u2022 Optional key : Key","title":"key"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#keyparams","text":"\u2022 Optional keyParams : string","title":"keyParams"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#keytype","text":"\u2022 Optional keyType : string","title":"keyType"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#kind","text":"\u2022 Optional kind : string","title":"kind"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#label","text":"\u2022 Optional label : string","title":"label"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#lang","text":"\u2022 Optional lang : string","title":"lang"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#list","text":"\u2022 Optional list : string","title":"list"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#loop","text":"\u2022 Optional loop : boolean","title":"loop"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#low","text":"\u2022 Optional low : number","title":"low"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#manifest","text":"\u2022 Optional manifest : string","title":"manifest"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#marginheight","text":"\u2022 Optional marginHeight : number","title":"marginHeight"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#marginwidth","text":"\u2022 Optional marginWidth : number","title":"marginWidth"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#max","text":"\u2022 Optional max : string | number","title":"max"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#maxlength","text":"\u2022 Optional maxLength : number","title":"maxLength"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#media","text":"\u2022 Optional media : string","title":"media"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#mediagroup","text":"\u2022 Optional mediaGroup : string","title":"mediaGroup"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#method","text":"\u2022 Optional method : string","title":"method"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#min","text":"\u2022 Optional min : string | number","title":"min"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#minlength","text":"\u2022 Optional minLength : number","title":"minLength"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#multiple","text":"\u2022 Optional multiple : boolean","title":"multiple"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#muted","text":"\u2022 Optional muted : boolean","title":"muted"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#nonce","text":"\u2022 Optional nonce : string","title":"nonce"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#open","text":"\u2022 Optional open : boolean","title":"open"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#optimum","text":"\u2022 Optional optimum : number","title":"optimum"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#pattern","text":"\u2022 Optional pattern : string","title":"pattern"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#placeholder","text":"\u2022 Optional placeholder : string","title":"placeholder"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#playsinline","text":"\u2022 Optional playsInline : boolean","title":"playsInline"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#poster","text":"\u2022 Optional poster : string","title":"poster"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#preload","text":"\u2022 Optional preload : string","title":"preload"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#property","text":"\u2022 Optional property : string","title":"property"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#radiogroup","text":"\u2022 Optional radioGroup : string","title":"radioGroup"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#ref","text":"\u2022 Optional ref : LegacyRef ","title":"ref"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#rel","text":"\u2022 Optional rel : string","title":"rel"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#required","text":"\u2022 Optional required : boolean","title":"required"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#resource","text":"\u2022 Optional resource : string","title":"resource"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#results","text":"\u2022 Optional results : number","title":"results"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#reversed","text":"\u2022 Optional reversed : boolean","title":"reversed"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#role","text":"\u2022 Optional role : string","title":"role"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#rowspan","text":"\u2022 Optional rowSpan : number","title":"rowSpan"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#rows","text":"\u2022 Optional rows : number","title":"rows"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#sandbox","text":"\u2022 Optional sandbox : string","title":"sandbox"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#scope","text":"\u2022 Optional scope : string","title":"scope"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#scoped","text":"\u2022 Optional scoped : boolean","title":"scoped"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#scrolling","text":"\u2022 Optional scrolling : string","title":"scrolling"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#seamless","text":"\u2022 Optional seamless : boolean","title":"seamless"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#security","text":"\u2022 Optional security : string","title":"security"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#shape","text":"\u2022 Optional shape : string","title":"shape"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#size","text":"\u2022 Optional size : number","title":"size"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#sizes","text":"\u2022 Optional sizes : string","title":"sizes"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#slot","text":"\u2022 Optional slot : string","title":"slot"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#span","text":"\u2022 Optional span : number","title":"span"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#spellcheck","text":"\u2022 Optional spellCheck : Booleanish","title":"spellCheck"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#src","text":"\u2022 Optional src : string","title":"src"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#srcdoc","text":"\u2022 Optional srcDoc : string","title":"srcDoc"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#srclang","text":"\u2022 Optional srcLang : string","title":"srcLang"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#srcset","text":"\u2022 Optional srcSet : string","title":"srcSet"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#start","text":"\u2022 Optional start : number","title":"start"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#step","text":"\u2022 step : number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#steps","text":"\u2022 steps : Step []","title":"steps"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#summary","text":"\u2022 Optional summary : string","title":"summary"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#suppresscontenteditablewarning","text":"\u2022 Optional suppressContentEditableWarning : boolean","title":"suppressContentEditableWarning"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#suppresshydrationwarning","text":"\u2022 Optional suppressHydrationWarning : boolean","title":"suppressHydrationWarning"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#tabindex","text":"\u2022 Optional tabIndex : number","title":"tabIndex"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#target","text":"\u2022 Optional target : string","title":"target"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#translate","text":"\u2022 Optional translate : \"yes\" | \"no\"","title":"translate"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#typeof","text":"\u2022 Optional typeof : string","title":"typeof"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#unselectable","text":"\u2022 Optional unselectable : \"on\" | \"off\"","title":"unselectable"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#usemap","text":"\u2022 Optional useMap : string","title":"useMap"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#value","text":"\u2022 Optional value : string | number | readonly string []","title":"value"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#vocab","text":"\u2022 Optional vocab : string","title":"vocab"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#wmode","text":"\u2022 Optional wmode : string","title":"wmode"},{"location":"extensions/api/interfaces/renderer.component.stepperprops/#wrap","text":"\u2022 Optional wrap : string","title":"wrap"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/","text":"Interface: TabLayoutProps # Renderer . Component .TabLayoutProps Table of contents # Properties # children className contentClass tabs Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName tabs # \u2022 Optional tabs : TabLayoutRoute []","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#interface-tablayoutprops","text":"Renderer . Component .TabLayoutProps","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#properties","text":"children className contentClass tabs","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/renderer.component.tablayoutprops/#tabs","text":"\u2022 Optional tabs : TabLayoutRoute []","title":"tabs"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/","text":"Interface: TabLayoutRoute # Renderer . Component .TabLayoutRoute Table of contents # Properties # component default exact routePath title url Properties # component # \u2022 component : ComponentType default # \u2022 Optional default : boolean exact # \u2022 Optional exact : boolean routePath # \u2022 routePath : string title # \u2022 title : ReactNode url # \u2022 Optional url : string","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#interface-tablayoutroute","text":"Renderer . Component .TabLayoutRoute","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#properties","text":"component default exact routePath title url","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#component","text":"\u2022 component : ComponentType ","title":"component"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#exact","text":"\u2022 Optional exact : boolean","title":"exact"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#routepath","text":"\u2022 routePath : string","title":"routePath"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/renderer.component.tablayoutroute/#url","text":"\u2022 Optional url : string","title":"url"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/","text":"Interface: TableCellProps # Renderer . Component .TableCellProps Hierarchy # DOMAttributes \u21b3 TableCellProps Table of contents # Properties # _nowrap _sorting checkbox children className dangerouslySetInnerHTML id isChecked onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture renderBoolean showWithColumn sortBy title Methods # _sort Properties # _nowrap # \u2022 Optional _nowrap : boolean _sorting # \u2022 Optional _sorting : Partial < TableSortParams > checkbox # \u2022 Optional checkbox : boolean children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : string dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML id # \u2022 Optional id : string isChecked # \u2022 Optional isChecked : boolean onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture renderBoolean # \u2022 Optional renderBoolean : boolean showWithColumn # \u2022 Optional showWithColumn : string sortBy # \u2022 Optional sortBy : string title # \u2022 Optional title : ReactNode Methods # _sort # \u25b8 Optional _sort ( sortBy ): void Parameters # Name Type sortBy string Returns # void","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#interface-tablecellprops","text":"Renderer . Component .TableCellProps","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#hierarchy","text":"DOMAttributes \u21b3 TableCellProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#properties","text":"_nowrap _sorting checkbox children className dangerouslySetInnerHTML id isChecked onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture renderBoolean showWithColumn sortBy title","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#methods","text":"_sort","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#_nowrap","text":"\u2022 Optional _nowrap : boolean","title":"_nowrap"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#_sorting","text":"\u2022 Optional _sorting : Partial < TableSortParams >","title":"_sorting"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#checkbox","text":"\u2022 Optional checkbox : boolean","title":"checkbox"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ischecked","text":"\u2022 Optional isChecked : boolean","title":"isChecked"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#renderboolean","text":"\u2022 Optional renderBoolean : boolean","title":"renderBoolean"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#showwithcolumn","text":"\u2022 Optional showWithColumn : string","title":"showWithColumn"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#sortby","text":"\u2022 Optional sortBy : string","title":"sortBy"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#title","text":"\u2022 Optional title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.tablecellprops/#_sort","text":"\u25b8 Optional _sort ( sortBy ): void","title":"_sort"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/","text":"Interface: TableHeadProps # Renderer . Component .TableHeadProps Hierarchy # DOMAttributes \u21b3 TableHeadProps Table of contents # Properties # children className dangerouslySetInnerHTML nowrap onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture showTopLine sticky Properties # children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : string dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML nowrap # \u2022 Optional nowrap : boolean onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture showTopLine # \u2022 Optional showTopLine : boolean sticky # \u2022 Optional sticky : boolean","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#interface-tableheadprops","text":"Renderer . Component .TableHeadProps","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#hierarchy","text":"DOMAttributes \u21b3 TableHeadProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#properties","text":"children className dangerouslySetInnerHTML nowrap onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture showTopLine sticky","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#showtopline","text":"\u2022 Optional showTopLine : boolean","title":"showTopLine"},{"location":"extensions/api/interfaces/renderer.component.tableheadprops/#sticky","text":"\u2022 Optional sticky : boolean","title":"sticky"},{"location":"extensions/api/interfaces/renderer.component.tableprops/","text":"Interface: TableProps # Renderer . Component .TableProps Type parameters # Name Item Hierarchy # DOMAttributes \u21b3 TableProps Table of contents # Properties # autoSize children className customRowHeights dangerouslySetInnerHTML getTableRow items noItems onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onSort onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual Properties # autoSize # \u2022 Optional autoSize : boolean children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : string customRowHeights # \u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number Type declaration # \u25b8 ( item , lineHeight , paddings ): number Parameters # Name Type item Item lineHeight number paddings number Returns # number dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML getTableRow # \u2022 Optional getTableRow : ( uid : string ) => ReactElement < TableRowProps , string | JSXElementConstructor> Type declaration # \u25b8 ( uid ): ReactElement < TableRowProps , string | JSXElementConstructor> Parameters # Name Type uid string Returns # ReactElement < TableRowProps , string | JSXElementConstructor> items # \u2022 Optional items : Item [] noItems # \u2022 Optional noItems : ReactNode onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onSort # \u2022 Optional onSort : ( params : TableSortParams ) => void Type declaration # \u25b8 ( params ): void Parameters # Name Type params TableSortParams Returns # void onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture renderRow # \u2022 Optional renderRow : ( item : Item ) => ReactElement < TableRowProps , string | JSXElementConstructor> Type declaration # \u25b8 ( item ): ReactElement < TableRowProps , string | JSXElementConstructor> Parameters # Name Type item Item Returns # ReactElement < TableRowProps , string | JSXElementConstructor> rowLineHeight # \u2022 Optional rowLineHeight : string rowPadding # \u2022 Optional rowPadding : string scrollable # \u2022 Optional scrollable : boolean selectable # \u2022 Optional selectable : boolean selectedItemId # \u2022 Optional selectedItemId : string sortByDefault # \u2022 Optional sortByDefault : Partial < TableSortParams > sortSyncWithUrl # \u2022 Optional sortSyncWithUrl : boolean sortable # \u2022 Optional sortable : TableSortCallbacks Define sortable callbacks for every column in sortitem argument in the callback is an object, provided in storageKey # \u2022 Optional storageKey : string tableId # \u2022 Optional tableId : string virtual # \u2022 Optional virtual : boolean","title":"Interface: TableProps"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#interface-tablepropsitem","text":"Renderer . Component .TableProps","title":"Interface: TableProps<Item>"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#hierarchy","text":"DOMAttributes \u21b3 TableProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#properties","text":"autoSize children className customRowHeights dangerouslySetInnerHTML getTableRow items noItems onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onSort onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#autosize","text":"\u2022 Optional autoSize : boolean","title":"autoSize"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#customrowheights","text":"\u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number","title":"customRowHeights"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#gettablerow","text":"\u2022 Optional getTableRow : ( uid : string ) => ReactElement < TableRowProps , string | JSXElementConstructor>","title":"getTableRow"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#items","text":"\u2022 Optional items : Item []","title":"items"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#noitems","text":"\u2022 Optional noItems : ReactNode","title":"noItems"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onsort","text":"\u2022 Optional onSort : ( params : TableSortParams ) => void","title":"onSort"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#renderrow","text":"\u2022 Optional renderRow : ( item : Item ) => ReactElement < TableRowProps , string | JSXElementConstructor>","title":"renderRow"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#rowlineheight","text":"\u2022 Optional rowLineHeight : string","title":"rowLineHeight"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#rowpadding","text":"\u2022 Optional rowPadding : string","title":"rowPadding"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#selectable","text":"\u2022 Optional selectable : boolean","title":"selectable"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#selecteditemid","text":"\u2022 Optional selectedItemId : string","title":"selectedItemId"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#sortbydefault","text":"\u2022 Optional sortByDefault : Partial < TableSortParams >","title":"sortByDefault"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#sortsyncwithurl","text":"\u2022 Optional sortSyncWithUrl : boolean","title":"sortSyncWithUrl"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#sortable","text":"\u2022 Optional sortable : TableSortCallbacks Define sortable callbacks for every column in sortitem argument in the callback is an object, provided in","title":"sortable"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#storagekey","text":"\u2022 Optional storageKey : string","title":"storageKey"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/renderer.component.tableprops/#virtual","text":"\u2022 Optional virtual : boolean","title":"virtual"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/","text":"Interface: TableRowProps # Renderer . Component .TableRowProps Hierarchy # DOMAttributes \u21b3 TableRowProps Table of contents # Properties # children className dangerouslySetInnerHTML disabled nowrap onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture searchItem selected sortItem style Properties # children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : string dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML disabled # \u2022 Optional disabled : boolean nowrap # \u2022 Optional nowrap : boolean onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture searchItem # \u2022 Optional searchItem : any selected # \u2022 Optional selected : boolean sortItem # \u2022 Optional sortItem : any style # \u2022 Optional style : CSSProperties","title":"Interface: TableRowProps"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#interface-tablerowprops","text":"Renderer . Component .TableRowProps","title":"Interface: TableRowProps"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#hierarchy","text":"DOMAttributes \u21b3 TableRowProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#properties","text":"children className dangerouslySetInnerHTML disabled nowrap onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture searchItem selected sortItem style","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#searchitem","text":"\u2022 Optional searchItem : any","title":"searchItem"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#sortitem","text":"\u2022 Optional sortItem : any","title":"sortItem"},{"location":"extensions/api/interfaces/renderer.component.tablerowprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.tabprops/","text":"Interface: TabProps # Renderer . Component .TabProps Type parameters # Name Type D D = any Hierarchy # DOMAttributes \u21b3 TabProps Table of contents # Properties # active children className dangerouslySetInnerHTML disabled icon id label onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture value Properties # active # \u2022 Optional active : boolean children # \u2022 Optional children : ReactNode Inherited from # DOMAttributes.children className # \u2022 Optional className : string dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # DOMAttributes.dangerouslySetInnerHTML disabled # \u2022 Optional disabled : boolean icon # \u2022 Optional icon : ReactNode id # \u2022 Optional id : string label # \u2022 Optional label : ReactNode onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # DOMAttributes.onWheelCapture value # \u2022 value : D","title":"Interface: TabProps"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#interface-tabpropsd","text":"Renderer . Component .TabProps","title":"Interface: TabProps<D>"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#type-parameters","text":"Name Type D D = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#hierarchy","text":"DOMAttributes \u21b3 TabProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#properties","text":"active children className dangerouslySetInnerHTML disabled icon id label onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture value","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabprops/#value","text":"\u2022 value : D","title":"value"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/","text":"Interface: TabsProps # Renderer . Component .TabsProps Type parameters # Name Type D D = any Hierarchy # TabsContextValue Omit , \"onChange\" > \u21b3 TabsProps Table of contents # Properties # autoFocus center children className dangerouslySetInnerHTML onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture scrollable value withBorder wrap Methods # onChange Properties # autoFocus # \u2022 Optional autoFocus : boolean Inherited from # TabsContextValue.autoFocus center # \u2022 Optional center : boolean children # \u2022 Optional children : ReactNode Inherited from # Omit.children className # \u2022 Optional className : string dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # Omit.dangerouslySetInnerHTML onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # Omit.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # Omit.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # Omit.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # Omit.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # Omit.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # Omit.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # Omit.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # Omit.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # Omit.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # Omit.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # Omit.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # Omit.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # Omit.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # Omit.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # Omit.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # Omit.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # Omit.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # Omit.onCanPlayThroughCapture onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # Omit.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # Omit.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # Omit.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # Omit.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # Omit.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # Omit.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # Omit.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # Omit.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # Omit.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # Omit.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # Omit.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # Omit.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # Omit.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # Omit.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # Omit.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # Omit.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # Omit.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # Omit.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # Omit.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # Omit.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # Omit.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # Omit.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # Omit.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # Omit.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # Omit.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # Omit.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # Omit.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # Omit.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # Omit.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # Omit.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # Omit.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # Omit.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # Omit.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # Omit.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # Omit.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # Omit.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # Omit.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # Omit.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # Omit.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # Omit.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # Omit.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # Omit.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # Omit.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # Omit.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # Omit.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # Omit.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # Omit.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # Omit.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # Omit.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # Omit.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # Omit.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # Omit.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # Omit.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # Omit.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # Omit.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # Omit.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # Omit.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # Omit.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # Omit.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # Omit.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # Omit.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # Omit.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # Omit.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # Omit.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # Omit.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # Omit.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # Omit.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # Omit.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # Omit.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # Omit.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # Omit.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # Omit.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # Omit.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # Omit.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # Omit.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # Omit.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # Omit.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # Omit.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # Omit.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # Omit.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # Omit.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # Omit.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # Omit.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # Omit.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # Omit.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # Omit.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # Omit.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # Omit.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # Omit.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # Omit.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # Omit.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # Omit.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # Omit.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # Omit.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # Omit.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # Omit.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # Omit.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # Omit.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # Omit.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # Omit.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # Omit.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # Omit.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # Omit.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # Omit.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # Omit.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # Omit.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # Omit.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # Omit.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # Omit.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # Omit.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # Omit.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # Omit.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # Omit.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # Omit.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # Omit.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # Omit.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # Omit.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # Omit.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # Omit.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # Omit.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # Omit.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # Omit.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # Omit.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # Omit.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # Omit.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # Omit.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # Omit.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # Omit.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # Omit.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # Omit.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # Omit.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # Omit.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # Omit.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # Omit.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # Omit.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # Omit.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # Omit.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # Omit.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # Omit.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # Omit.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # Omit.onWheelCapture scrollable # \u2022 Optional scrollable : boolean value # \u2022 Optional value : D Inherited from # TabsContextValue.value withBorder # \u2022 Optional withBorder : boolean Inherited from # TabsContextValue.withBorder wrap # \u2022 Optional wrap : boolean Methods # onChange # \u25b8 Optional onChange ( value ): void Parameters # Name Type value D Returns # void Inherited from # TabsContextValue.onChange","title":"Interface: TabsProps"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#interface-tabspropsd","text":"Renderer . Component .TabsProps","title":"Interface: TabsProps<D>"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#type-parameters","text":"Name Type D D = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#hierarchy","text":"TabsContextValue Omit , \"onChange\" > \u21b3 TabsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#properties","text":"autoFocus center children className dangerouslySetInnerHTML onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture scrollable value withBorder wrap","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#value","text":"\u2022 Optional value : D","title":"value"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#withborder","text":"\u2022 Optional withBorder : boolean","title":"withBorder"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#wrap","text":"\u2022 Optional wrap : boolean","title":"wrap"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.component.tabsprops/#onchange","text":"\u25b8 Optional onChange ( value ): void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/","text":"Interface: TooltipContentFormatters # Renderer . Component .TooltipContentFormatters Table of contents # Properties # narrow nowrap small tableView warning Properties # narrow # \u2022 Optional narrow : boolean nowrap # \u2022 Optional nowrap : boolean small # \u2022 Optional small : boolean tableView # \u2022 Optional tableView : boolean warning # \u2022 Optional warning : boolean","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#interface-tooltipcontentformatters","text":"Renderer . Component .TooltipContentFormatters","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#properties","text":"narrow nowrap small tableView warning","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#narrow","text":"\u2022 Optional narrow : boolean","title":"narrow"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#tableview","text":"\u2022 Optional tableView : boolean","title":"tableView"},{"location":"extensions/api/interfaces/renderer.component.tooltipcontentformatters/#warning","text":"\u2022 Optional warning : boolean","title":"warning"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/","text":"Interface: TooltipDecoratorProps # Renderer . Component .TooltipDecoratorProps Hierarchy # TooltipDecoratorProps \u21b3 ButtonProps \u21b3 IconProps \u21b3 BadgeProps \u21b3 LineProgressProps \u21b3 StatusBrickProps Table of contents # Properties # tooltip tooltipOverrideDisabled Properties # tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > tooltipOverrideDisabled # \u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#interface-tooltipdecoratorprops","text":"Renderer . Component .TooltipDecoratorProps","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#hierarchy","text":"TooltipDecoratorProps \u21b3 ButtonProps \u21b3 IconProps \u21b3 BadgeProps \u21b3 LineProgressProps \u21b3 StatusBrickProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#properties","text":"tooltip tooltipOverrideDisabled","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/renderer.component.tooltipdecoratorprops/#tooltipoverridedisabled","text":"\u2022 Optional tooltipOverrideDisabled : boolean forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/","text":"Interface: TooltipProps # Renderer . Component .TooltipProps Table of contents # Properties # children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName formatters # \u2022 Optional formatters : TooltipContentFormatters offset # \u2022 Optional offset : number preferredPositions # \u2022 Optional preferredPositions : TooltipPosition | TooltipPosition [] style # \u2022 Optional style : CSSProperties targetId # \u2022 targetId : string tooltipOnParentHover # \u2022 Optional tooltipOnParentHover : boolean usePortal # \u2022 Optional usePortal : boolean visible # \u2022 Optional visible : boolean","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#interface-tooltipprops","text":"Renderer . Component .TooltipProps","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#properties","text":"children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#formatters","text":"\u2022 Optional formatters : TooltipContentFormatters","title":"formatters"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#offset","text":"\u2022 Optional offset : number","title":"offset"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#preferredpositions","text":"\u2022 Optional preferredPositions : TooltipPosition | TooltipPosition []","title":"preferredPositions"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#targetid","text":"\u2022 targetId : string","title":"targetId"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#tooltiponparenthover","text":"\u2022 Optional tooltipOnParentHover : boolean","title":"tooltipOnParentHover"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/renderer.component.tooltipprops/#visible","text":"\u2022 Optional visible : boolean","title":"visible"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/","text":"Interface: WizardLayoutProps # Renderer . Component .WizardLayoutProps Hierarchy # DOMAttributes \u21b3 WizardLayoutProps Table of contents # Properties # centered children className contentClass dangerouslySetInnerHTML header headerClass infoPanel infoPanelClass onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture Properties # centered # \u2022 Optional centered : boolean children # \u2022 Optional children : ReactNode Inherited from # React.DOMAttributes.children className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName dangerouslySetInnerHTML # \u2022 Optional dangerouslySetInnerHTML : Object Type declaration # Name Type __html string Inherited from # React.DOMAttributes.dangerouslySetInnerHTML header # \u2022 Optional header : ReactNode headerClass # \u2022 Optional headerClass : IClassName infoPanel # \u2022 Optional infoPanel : ReactNode infoPanelClass # \u2022 Optional infoPanelClass : IClassName onAbort # \u2022 Optional onAbort : ReactEventHandler Inherited from # React.DOMAttributes.onAbort onAbortCapture # \u2022 Optional onAbortCapture : ReactEventHandler Inherited from # React.DOMAttributes.onAbortCapture onAnimationEnd # \u2022 Optional onAnimationEnd : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEnd onAnimationEndCapture # \u2022 Optional onAnimationEndCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationEndCapture onAnimationIteration # \u2022 Optional onAnimationIteration : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIteration onAnimationIterationCapture # \u2022 Optional onAnimationIterationCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationIterationCapture onAnimationStart # \u2022 Optional onAnimationStart : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStart onAnimationStartCapture # \u2022 Optional onAnimationStartCapture : AnimationEventHandler Inherited from # React.DOMAttributes.onAnimationStartCapture onAuxClick # \u2022 Optional onAuxClick : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClick onAuxClickCapture # \u2022 Optional onAuxClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onAuxClickCapture onBeforeInput # \u2022 Optional onBeforeInput : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInput onBeforeInputCapture # \u2022 Optional onBeforeInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onBeforeInputCapture onBlur # \u2022 Optional onBlur : FocusEventHandler Inherited from # React.DOMAttributes.onBlur onBlurCapture # \u2022 Optional onBlurCapture : FocusEventHandler Inherited from # React.DOMAttributes.onBlurCapture onCanPlay # \u2022 Optional onCanPlay : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlay onCanPlayCapture # \u2022 Optional onCanPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayCapture onCanPlayThrough # \u2022 Optional onCanPlayThrough : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThrough onCanPlayThroughCapture # \u2022 Optional onCanPlayThroughCapture : ReactEventHandler Inherited from # React.DOMAttributes.onCanPlayThroughCapture onChange # \u2022 Optional onChange : FormEventHandler Inherited from # React.DOMAttributes.onChange onChangeCapture # \u2022 Optional onChangeCapture : FormEventHandler Inherited from # React.DOMAttributes.onChangeCapture onClick # \u2022 Optional onClick : MouseEventHandler Inherited from # React.DOMAttributes.onClick onClickCapture # \u2022 Optional onClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onClickCapture onCompositionEnd # \u2022 Optional onCompositionEnd : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEnd onCompositionEndCapture # \u2022 Optional onCompositionEndCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionEndCapture onCompositionStart # \u2022 Optional onCompositionStart : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStart onCompositionStartCapture # \u2022 Optional onCompositionStartCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionStartCapture onCompositionUpdate # \u2022 Optional onCompositionUpdate : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdate onCompositionUpdateCapture # \u2022 Optional onCompositionUpdateCapture : CompositionEventHandler Inherited from # React.DOMAttributes.onCompositionUpdateCapture onContextMenu # \u2022 Optional onContextMenu : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenu onContextMenuCapture # \u2022 Optional onContextMenuCapture : MouseEventHandler Inherited from # React.DOMAttributes.onContextMenuCapture onCopy # \u2022 Optional onCopy : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopy onCopyCapture # \u2022 Optional onCopyCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCopyCapture onCut # \u2022 Optional onCut : ClipboardEventHandler Inherited from # React.DOMAttributes.onCut onCutCapture # \u2022 Optional onCutCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onCutCapture onDoubleClick # \u2022 Optional onDoubleClick : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClick onDoubleClickCapture # \u2022 Optional onDoubleClickCapture : MouseEventHandler Inherited from # React.DOMAttributes.onDoubleClickCapture onDrag # \u2022 Optional onDrag : DragEventHandler Inherited from # React.DOMAttributes.onDrag onDragCapture # \u2022 Optional onDragCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragCapture onDragEnd # \u2022 Optional onDragEnd : DragEventHandler Inherited from # React.DOMAttributes.onDragEnd onDragEndCapture # \u2022 Optional onDragEndCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEndCapture onDragEnter # \u2022 Optional onDragEnter : DragEventHandler Inherited from # React.DOMAttributes.onDragEnter onDragEnterCapture # \u2022 Optional onDragEnterCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragEnterCapture onDragExit # \u2022 Optional onDragExit : DragEventHandler Inherited from # React.DOMAttributes.onDragExit onDragExitCapture # \u2022 Optional onDragExitCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragExitCapture onDragLeave # \u2022 Optional onDragLeave : DragEventHandler Inherited from # React.DOMAttributes.onDragLeave onDragLeaveCapture # \u2022 Optional onDragLeaveCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragLeaveCapture onDragOver # \u2022 Optional onDragOver : DragEventHandler Inherited from # React.DOMAttributes.onDragOver onDragOverCapture # \u2022 Optional onDragOverCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragOverCapture onDragStart # \u2022 Optional onDragStart : DragEventHandler Inherited from # React.DOMAttributes.onDragStart onDragStartCapture # \u2022 Optional onDragStartCapture : DragEventHandler Inherited from # React.DOMAttributes.onDragStartCapture onDrop # \u2022 Optional onDrop : DragEventHandler Inherited from # React.DOMAttributes.onDrop onDropCapture # \u2022 Optional onDropCapture : DragEventHandler Inherited from # React.DOMAttributes.onDropCapture onDurationChange # \u2022 Optional onDurationChange : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChange onDurationChangeCapture # \u2022 Optional onDurationChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onDurationChangeCapture onEmptied # \u2022 Optional onEmptied : ReactEventHandler Inherited from # React.DOMAttributes.onEmptied onEmptiedCapture # \u2022 Optional onEmptiedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEmptiedCapture onEncrypted # \u2022 Optional onEncrypted : ReactEventHandler Inherited from # React.DOMAttributes.onEncrypted onEncryptedCapture # \u2022 Optional onEncryptedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEncryptedCapture onEnded # \u2022 Optional onEnded : ReactEventHandler Inherited from # React.DOMAttributes.onEnded onEndedCapture # \u2022 Optional onEndedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onEndedCapture onError # \u2022 Optional onError : ReactEventHandler Inherited from # React.DOMAttributes.onError onErrorCapture # \u2022 Optional onErrorCapture : ReactEventHandler Inherited from # React.DOMAttributes.onErrorCapture onFocus # \u2022 Optional onFocus : FocusEventHandler Inherited from # React.DOMAttributes.onFocus onFocusCapture # \u2022 Optional onFocusCapture : FocusEventHandler Inherited from # React.DOMAttributes.onFocusCapture onGotPointerCapture # \u2022 Optional onGotPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCapture onGotPointerCaptureCapture # \u2022 Optional onGotPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onGotPointerCaptureCapture onInput # \u2022 Optional onInput : FormEventHandler Inherited from # React.DOMAttributes.onInput onInputCapture # \u2022 Optional onInputCapture : FormEventHandler Inherited from # React.DOMAttributes.onInputCapture onInvalid # \u2022 Optional onInvalid : FormEventHandler Inherited from # React.DOMAttributes.onInvalid onInvalidCapture # \u2022 Optional onInvalidCapture : FormEventHandler Inherited from # React.DOMAttributes.onInvalidCapture onKeyDown # \u2022 Optional onKeyDown : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDown onKeyDownCapture # \u2022 Optional onKeyDownCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyDownCapture onKeyPress # \u2022 Optional onKeyPress : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPress onKeyPressCapture # \u2022 Optional onKeyPressCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyPressCapture onKeyUp # \u2022 Optional onKeyUp : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUp onKeyUpCapture # \u2022 Optional onKeyUpCapture : KeyboardEventHandler Inherited from # React.DOMAttributes.onKeyUpCapture onLoad # \u2022 Optional onLoad : ReactEventHandler Inherited from # React.DOMAttributes.onLoad onLoadCapture # \u2022 Optional onLoadCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadCapture onLoadStart # \u2022 Optional onLoadStart : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStart onLoadStartCapture # \u2022 Optional onLoadStartCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadStartCapture onLoadedData # \u2022 Optional onLoadedData : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedData onLoadedDataCapture # \u2022 Optional onLoadedDataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedDataCapture onLoadedMetadata # \u2022 Optional onLoadedMetadata : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadata onLoadedMetadataCapture # \u2022 Optional onLoadedMetadataCapture : ReactEventHandler Inherited from # React.DOMAttributes.onLoadedMetadataCapture onLostPointerCapture # \u2022 Optional onLostPointerCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCapture onLostPointerCaptureCapture # \u2022 Optional onLostPointerCaptureCapture : PointerEventHandler Inherited from # React.DOMAttributes.onLostPointerCaptureCapture onMouseDown # \u2022 Optional onMouseDown : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDown onMouseDownCapture # \u2022 Optional onMouseDownCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseDownCapture onMouseEnter # \u2022 Optional onMouseEnter : MouseEventHandler Inherited from # React.DOMAttributes.onMouseEnter onMouseLeave # \u2022 Optional onMouseLeave : MouseEventHandler Inherited from # React.DOMAttributes.onMouseLeave onMouseMove # \u2022 Optional onMouseMove : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMove onMouseMoveCapture # \u2022 Optional onMouseMoveCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseMoveCapture onMouseOut # \u2022 Optional onMouseOut : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOut onMouseOutCapture # \u2022 Optional onMouseOutCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOutCapture onMouseOver # \u2022 Optional onMouseOver : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOver onMouseOverCapture # \u2022 Optional onMouseOverCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseOverCapture onMouseUp # \u2022 Optional onMouseUp : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUp onMouseUpCapture # \u2022 Optional onMouseUpCapture : MouseEventHandler Inherited from # React.DOMAttributes.onMouseUpCapture onPaste # \u2022 Optional onPaste : ClipboardEventHandler Inherited from # React.DOMAttributes.onPaste onPasteCapture # \u2022 Optional onPasteCapture : ClipboardEventHandler Inherited from # React.DOMAttributes.onPasteCapture onPause # \u2022 Optional onPause : ReactEventHandler Inherited from # React.DOMAttributes.onPause onPauseCapture # \u2022 Optional onPauseCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPauseCapture onPlay # \u2022 Optional onPlay : ReactEventHandler Inherited from # React.DOMAttributes.onPlay onPlayCapture # \u2022 Optional onPlayCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayCapture onPlaying # \u2022 Optional onPlaying : ReactEventHandler Inherited from # React.DOMAttributes.onPlaying onPlayingCapture # \u2022 Optional onPlayingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onPlayingCapture onPointerCancel # \u2022 Optional onPointerCancel : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancel onPointerCancelCapture # \u2022 Optional onPointerCancelCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerCancelCapture onPointerDown # \u2022 Optional onPointerDown : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDown onPointerDownCapture # \u2022 Optional onPointerDownCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerDownCapture onPointerEnter # \u2022 Optional onPointerEnter : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnter onPointerEnterCapture # \u2022 Optional onPointerEnterCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerEnterCapture onPointerLeave # \u2022 Optional onPointerLeave : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeave onPointerLeaveCapture # \u2022 Optional onPointerLeaveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerLeaveCapture onPointerMove # \u2022 Optional onPointerMove : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMove onPointerMoveCapture # \u2022 Optional onPointerMoveCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerMoveCapture onPointerOut # \u2022 Optional onPointerOut : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOut onPointerOutCapture # \u2022 Optional onPointerOutCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOutCapture onPointerOver # \u2022 Optional onPointerOver : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOver onPointerOverCapture # \u2022 Optional onPointerOverCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerOverCapture onPointerUp # \u2022 Optional onPointerUp : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUp onPointerUpCapture # \u2022 Optional onPointerUpCapture : PointerEventHandler Inherited from # React.DOMAttributes.onPointerUpCapture onProgress # \u2022 Optional onProgress : ReactEventHandler Inherited from # React.DOMAttributes.onProgress onProgressCapture # \u2022 Optional onProgressCapture : ReactEventHandler Inherited from # React.DOMAttributes.onProgressCapture onRateChange # \u2022 Optional onRateChange : ReactEventHandler Inherited from # React.DOMAttributes.onRateChange onRateChangeCapture # \u2022 Optional onRateChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onRateChangeCapture onReset # \u2022 Optional onReset : FormEventHandler Inherited from # React.DOMAttributes.onReset onResetCapture # \u2022 Optional onResetCapture : FormEventHandler Inherited from # React.DOMAttributes.onResetCapture onScroll # \u2022 Optional onScroll : UIEventHandler Inherited from # React.DOMAttributes.onScroll onScrollCapture # \u2022 Optional onScrollCapture : UIEventHandler Inherited from # React.DOMAttributes.onScrollCapture onSeeked # \u2022 Optional onSeeked : ReactEventHandler Inherited from # React.DOMAttributes.onSeeked onSeekedCapture # \u2022 Optional onSeekedCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekedCapture onSeeking # \u2022 Optional onSeeking : ReactEventHandler Inherited from # React.DOMAttributes.onSeeking onSeekingCapture # \u2022 Optional onSeekingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSeekingCapture onSelect # \u2022 Optional onSelect : ReactEventHandler Inherited from # React.DOMAttributes.onSelect onSelectCapture # \u2022 Optional onSelectCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSelectCapture onStalled # \u2022 Optional onStalled : ReactEventHandler Inherited from # React.DOMAttributes.onStalled onStalledCapture # \u2022 Optional onStalledCapture : ReactEventHandler Inherited from # React.DOMAttributes.onStalledCapture onSubmit # \u2022 Optional onSubmit : FormEventHandler Inherited from # React.DOMAttributes.onSubmit onSubmitCapture # \u2022 Optional onSubmitCapture : FormEventHandler Inherited from # React.DOMAttributes.onSubmitCapture onSuspend # \u2022 Optional onSuspend : ReactEventHandler Inherited from # React.DOMAttributes.onSuspend onSuspendCapture # \u2022 Optional onSuspendCapture : ReactEventHandler Inherited from # React.DOMAttributes.onSuspendCapture onTimeUpdate # \u2022 Optional onTimeUpdate : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdate onTimeUpdateCapture # \u2022 Optional onTimeUpdateCapture : ReactEventHandler Inherited from # React.DOMAttributes.onTimeUpdateCapture onTouchCancel # \u2022 Optional onTouchCancel : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancel onTouchCancelCapture # \u2022 Optional onTouchCancelCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchCancelCapture onTouchEnd # \u2022 Optional onTouchEnd : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEnd onTouchEndCapture # \u2022 Optional onTouchEndCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchEndCapture onTouchMove # \u2022 Optional onTouchMove : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMove onTouchMoveCapture # \u2022 Optional onTouchMoveCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchMoveCapture onTouchStart # \u2022 Optional onTouchStart : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStart onTouchStartCapture # \u2022 Optional onTouchStartCapture : TouchEventHandler Inherited from # React.DOMAttributes.onTouchStartCapture onTransitionEnd # \u2022 Optional onTransitionEnd : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEnd onTransitionEndCapture # \u2022 Optional onTransitionEndCapture : TransitionEventHandler Inherited from # React.DOMAttributes.onTransitionEndCapture onVolumeChange # \u2022 Optional onVolumeChange : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChange onVolumeChangeCapture # \u2022 Optional onVolumeChangeCapture : ReactEventHandler Inherited from # React.DOMAttributes.onVolumeChangeCapture onWaiting # \u2022 Optional onWaiting : ReactEventHandler Inherited from # React.DOMAttributes.onWaiting onWaitingCapture # \u2022 Optional onWaitingCapture : ReactEventHandler Inherited from # React.DOMAttributes.onWaitingCapture onWheel # \u2022 Optional onWheel : WheelEventHandler Inherited from # React.DOMAttributes.onWheel onWheelCapture # \u2022 Optional onWheelCapture : WheelEventHandler Inherited from # React.DOMAttributes.onWheelCapture","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#interface-wizardlayoutprops","text":"Renderer . Component .WizardLayoutProps","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#hierarchy","text":"DOMAttributes \u21b3 WizardLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#properties","text":"centered children className contentClass dangerouslySetInnerHTML header headerClass infoPanel infoPanelClass onAbort onAbortCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onAnimationStart onAnimationStartCapture onAuxClick onAuxClickCapture onBeforeInput onBeforeInputCapture onBlur onBlurCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onChange onChangeCapture onClick onClickCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onContextMenu onContextMenuCapture onCopy onCopyCapture onCut onCutCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onError onErrorCapture onFocus onFocusCapture onGotPointerCapture onGotPointerCaptureCapture onInput onInputCapture onInvalid onInvalidCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onLoad onLoadCapture onLoadStart onLoadStartCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLostPointerCapture onLostPointerCaptureCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onPaste onPasteCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onPointerCancel onPointerCancelCapture onPointerDown onPointerDownCapture onPointerEnter onPointerEnterCapture onPointerLeave onPointerLeaveCapture onPointerMove onPointerMoveCapture onPointerOut onPointerOutCapture onPointerOver onPointerOverCapture onPointerUp onPointerUpCapture onProgress onProgressCapture onRateChange onRateChangeCapture onReset onResetCapture onScroll onScrollCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onSelect onSelectCapture onStalled onStalledCapture onSubmit onSubmitCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onTransitionEnd onTransitionEndCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onWheel onWheelCapture","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#centered","text":"\u2022 Optional centered : boolean","title":"centered"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#dangerouslysetinnerhtml","text":"\u2022 Optional dangerouslySetInnerHTML : Object","title":"dangerouslySetInnerHTML"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#headerclass","text":"\u2022 Optional headerClass : IClassName","title":"headerClass"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#infopanel","text":"\u2022 Optional infoPanel : ReactNode","title":"infoPanel"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#infopanelclass","text":"\u2022 Optional infoPanelClass : IClassName","title":"infoPanelClass"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onabort","text":"\u2022 Optional onAbort : ReactEventHandler ","title":"onAbort"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onabortcapture","text":"\u2022 Optional onAbortCapture : ReactEventHandler ","title":"onAbortCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationend","text":"\u2022 Optional onAnimationEnd : AnimationEventHandler ","title":"onAnimationEnd"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationendcapture","text":"\u2022 Optional onAnimationEndCapture : AnimationEventHandler ","title":"onAnimationEndCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationiteration","text":"\u2022 Optional onAnimationIteration : AnimationEventHandler ","title":"onAnimationIteration"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationiterationcapture","text":"\u2022 Optional onAnimationIterationCapture : AnimationEventHandler ","title":"onAnimationIterationCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationstart","text":"\u2022 Optional onAnimationStart : AnimationEventHandler ","title":"onAnimationStart"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onanimationstartcapture","text":"\u2022 Optional onAnimationStartCapture : AnimationEventHandler ","title":"onAnimationStartCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onauxclick","text":"\u2022 Optional onAuxClick : MouseEventHandler ","title":"onAuxClick"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onauxclickcapture","text":"\u2022 Optional onAuxClickCapture : MouseEventHandler ","title":"onAuxClickCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onbeforeinput","text":"\u2022 Optional onBeforeInput : FormEventHandler ","title":"onBeforeInput"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onbeforeinputcapture","text":"\u2022 Optional onBeforeInputCapture : FormEventHandler ","title":"onBeforeInputCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onblur","text":"\u2022 Optional onBlur : FocusEventHandler ","title":"onBlur"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onblurcapture","text":"\u2022 Optional onBlurCapture : FocusEventHandler ","title":"onBlurCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncanplay","text":"\u2022 Optional onCanPlay : ReactEventHandler ","title":"onCanPlay"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncanplaycapture","text":"\u2022 Optional onCanPlayCapture : ReactEventHandler ","title":"onCanPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncanplaythrough","text":"\u2022 Optional onCanPlayThrough : ReactEventHandler ","title":"onCanPlayThrough"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncanplaythroughcapture","text":"\u2022 Optional onCanPlayThroughCapture : ReactEventHandler ","title":"onCanPlayThroughCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onchange","text":"\u2022 Optional onChange : FormEventHandler ","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onchangecapture","text":"\u2022 Optional onChangeCapture : FormEventHandler ","title":"onChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onclick","text":"\u2022 Optional onClick : MouseEventHandler ","title":"onClick"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onclickcapture","text":"\u2022 Optional onClickCapture : MouseEventHandler ","title":"onClickCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionend","text":"\u2022 Optional onCompositionEnd : CompositionEventHandler ","title":"onCompositionEnd"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionendcapture","text":"\u2022 Optional onCompositionEndCapture : CompositionEventHandler ","title":"onCompositionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionstart","text":"\u2022 Optional onCompositionStart : CompositionEventHandler ","title":"onCompositionStart"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionstartcapture","text":"\u2022 Optional onCompositionStartCapture : CompositionEventHandler ","title":"onCompositionStartCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionupdate","text":"\u2022 Optional onCompositionUpdate : CompositionEventHandler ","title":"onCompositionUpdate"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncompositionupdatecapture","text":"\u2022 Optional onCompositionUpdateCapture : CompositionEventHandler ","title":"onCompositionUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncontextmenu","text":"\u2022 Optional onContextMenu : MouseEventHandler ","title":"onContextMenu"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncontextmenucapture","text":"\u2022 Optional onContextMenuCapture : MouseEventHandler ","title":"onContextMenuCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncopy","text":"\u2022 Optional onCopy : ClipboardEventHandler ","title":"onCopy"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncopycapture","text":"\u2022 Optional onCopyCapture : ClipboardEventHandler ","title":"onCopyCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncut","text":"\u2022 Optional onCut : ClipboardEventHandler ","title":"onCut"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oncutcapture","text":"\u2022 Optional onCutCapture : ClipboardEventHandler ","title":"onCutCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondoubleclick","text":"\u2022 Optional onDoubleClick : MouseEventHandler ","title":"onDoubleClick"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondoubleclickcapture","text":"\u2022 Optional onDoubleClickCapture : MouseEventHandler ","title":"onDoubleClickCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondrag","text":"\u2022 Optional onDrag : DragEventHandler ","title":"onDrag"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragcapture","text":"\u2022 Optional onDragCapture : DragEventHandler ","title":"onDragCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragend","text":"\u2022 Optional onDragEnd : DragEventHandler ","title":"onDragEnd"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragendcapture","text":"\u2022 Optional onDragEndCapture : DragEventHandler ","title":"onDragEndCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragenter","text":"\u2022 Optional onDragEnter : DragEventHandler ","title":"onDragEnter"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragentercapture","text":"\u2022 Optional onDragEnterCapture : DragEventHandler ","title":"onDragEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragexit","text":"\u2022 Optional onDragExit : DragEventHandler ","title":"onDragExit"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragexitcapture","text":"\u2022 Optional onDragExitCapture : DragEventHandler ","title":"onDragExitCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragleave","text":"\u2022 Optional onDragLeave : DragEventHandler ","title":"onDragLeave"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragleavecapture","text":"\u2022 Optional onDragLeaveCapture : DragEventHandler ","title":"onDragLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragover","text":"\u2022 Optional onDragOver : DragEventHandler ","title":"onDragOver"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragovercapture","text":"\u2022 Optional onDragOverCapture : DragEventHandler ","title":"onDragOverCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragstart","text":"\u2022 Optional onDragStart : DragEventHandler ","title":"onDragStart"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondragstartcapture","text":"\u2022 Optional onDragStartCapture : DragEventHandler ","title":"onDragStartCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondrop","text":"\u2022 Optional onDrop : DragEventHandler ","title":"onDrop"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondropcapture","text":"\u2022 Optional onDropCapture : DragEventHandler ","title":"onDropCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondurationchange","text":"\u2022 Optional onDurationChange : ReactEventHandler ","title":"onDurationChange"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ondurationchangecapture","text":"\u2022 Optional onDurationChangeCapture : ReactEventHandler ","title":"onDurationChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onemptied","text":"\u2022 Optional onEmptied : ReactEventHandler ","title":"onEmptied"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onemptiedcapture","text":"\u2022 Optional onEmptiedCapture : ReactEventHandler ","title":"onEmptiedCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onencrypted","text":"\u2022 Optional onEncrypted : ReactEventHandler ","title":"onEncrypted"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onencryptedcapture","text":"\u2022 Optional onEncryptedCapture : ReactEventHandler ","title":"onEncryptedCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onended","text":"\u2022 Optional onEnded : ReactEventHandler ","title":"onEnded"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onendedcapture","text":"\u2022 Optional onEndedCapture : ReactEventHandler ","title":"onEndedCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onerror","text":"\u2022 Optional onError : ReactEventHandler ","title":"onError"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onerrorcapture","text":"\u2022 Optional onErrorCapture : ReactEventHandler ","title":"onErrorCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onfocus","text":"\u2022 Optional onFocus : FocusEventHandler ","title":"onFocus"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onfocuscapture","text":"\u2022 Optional onFocusCapture : FocusEventHandler ","title":"onFocusCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ongotpointercapture","text":"\u2022 Optional onGotPointerCapture : PointerEventHandler ","title":"onGotPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ongotpointercapturecapture","text":"\u2022 Optional onGotPointerCaptureCapture : PointerEventHandler ","title":"onGotPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oninput","text":"\u2022 Optional onInput : FormEventHandler ","title":"onInput"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oninputcapture","text":"\u2022 Optional onInputCapture : FormEventHandler ","title":"onInputCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oninvalid","text":"\u2022 Optional onInvalid : FormEventHandler ","title":"onInvalid"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#oninvalidcapture","text":"\u2022 Optional onInvalidCapture : FormEventHandler ","title":"onInvalidCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeydown","text":"\u2022 Optional onKeyDown : KeyboardEventHandler ","title":"onKeyDown"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeydowncapture","text":"\u2022 Optional onKeyDownCapture : KeyboardEventHandler ","title":"onKeyDownCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeypress","text":"\u2022 Optional onKeyPress : KeyboardEventHandler ","title":"onKeyPress"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeypresscapture","text":"\u2022 Optional onKeyPressCapture : KeyboardEventHandler ","title":"onKeyPressCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeyup","text":"\u2022 Optional onKeyUp : KeyboardEventHandler ","title":"onKeyUp"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onkeyupcapture","text":"\u2022 Optional onKeyUpCapture : KeyboardEventHandler ","title":"onKeyUpCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onload","text":"\u2022 Optional onLoad : ReactEventHandler ","title":"onLoad"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadcapture","text":"\u2022 Optional onLoadCapture : ReactEventHandler ","title":"onLoadCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadstart","text":"\u2022 Optional onLoadStart : ReactEventHandler ","title":"onLoadStart"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadstartcapture","text":"\u2022 Optional onLoadStartCapture : ReactEventHandler ","title":"onLoadStartCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadeddata","text":"\u2022 Optional onLoadedData : ReactEventHandler ","title":"onLoadedData"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadeddatacapture","text":"\u2022 Optional onLoadedDataCapture : ReactEventHandler ","title":"onLoadedDataCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadedmetadata","text":"\u2022 Optional onLoadedMetadata : ReactEventHandler ","title":"onLoadedMetadata"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onloadedmetadatacapture","text":"\u2022 Optional onLoadedMetadataCapture : ReactEventHandler ","title":"onLoadedMetadataCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onlostpointercapture","text":"\u2022 Optional onLostPointerCapture : PointerEventHandler ","title":"onLostPointerCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onlostpointercapturecapture","text":"\u2022 Optional onLostPointerCaptureCapture : PointerEventHandler ","title":"onLostPointerCaptureCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmousedown","text":"\u2022 Optional onMouseDown : MouseEventHandler ","title":"onMouseDown"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmousedowncapture","text":"\u2022 Optional onMouseDownCapture : MouseEventHandler ","title":"onMouseDownCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseenter","text":"\u2022 Optional onMouseEnter : MouseEventHandler ","title":"onMouseEnter"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseleave","text":"\u2022 Optional onMouseLeave : MouseEventHandler ","title":"onMouseLeave"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmousemove","text":"\u2022 Optional onMouseMove : MouseEventHandler ","title":"onMouseMove"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmousemovecapture","text":"\u2022 Optional onMouseMoveCapture : MouseEventHandler ","title":"onMouseMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseout","text":"\u2022 Optional onMouseOut : MouseEventHandler ","title":"onMouseOut"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseoutcapture","text":"\u2022 Optional onMouseOutCapture : MouseEventHandler ","title":"onMouseOutCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseover","text":"\u2022 Optional onMouseOver : MouseEventHandler ","title":"onMouseOver"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseovercapture","text":"\u2022 Optional onMouseOverCapture : MouseEventHandler ","title":"onMouseOverCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseup","text":"\u2022 Optional onMouseUp : MouseEventHandler ","title":"onMouseUp"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onmouseupcapture","text":"\u2022 Optional onMouseUpCapture : MouseEventHandler ","title":"onMouseUpCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpaste","text":"\u2022 Optional onPaste : ClipboardEventHandler ","title":"onPaste"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpastecapture","text":"\u2022 Optional onPasteCapture : ClipboardEventHandler ","title":"onPasteCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpause","text":"\u2022 Optional onPause : ReactEventHandler ","title":"onPause"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpausecapture","text":"\u2022 Optional onPauseCapture : ReactEventHandler ","title":"onPauseCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onplay","text":"\u2022 Optional onPlay : ReactEventHandler ","title":"onPlay"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onplaycapture","text":"\u2022 Optional onPlayCapture : ReactEventHandler ","title":"onPlayCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onplaying","text":"\u2022 Optional onPlaying : ReactEventHandler ","title":"onPlaying"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onplayingcapture","text":"\u2022 Optional onPlayingCapture : ReactEventHandler ","title":"onPlayingCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointercancel","text":"\u2022 Optional onPointerCancel : PointerEventHandler ","title":"onPointerCancel"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointercancelcapture","text":"\u2022 Optional onPointerCancelCapture : PointerEventHandler ","title":"onPointerCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerdown","text":"\u2022 Optional onPointerDown : PointerEventHandler ","title":"onPointerDown"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerdowncapture","text":"\u2022 Optional onPointerDownCapture : PointerEventHandler ","title":"onPointerDownCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerenter","text":"\u2022 Optional onPointerEnter : PointerEventHandler ","title":"onPointerEnter"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerentercapture","text":"\u2022 Optional onPointerEnterCapture : PointerEventHandler ","title":"onPointerEnterCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerleave","text":"\u2022 Optional onPointerLeave : PointerEventHandler ","title":"onPointerLeave"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerleavecapture","text":"\u2022 Optional onPointerLeaveCapture : PointerEventHandler ","title":"onPointerLeaveCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointermove","text":"\u2022 Optional onPointerMove : PointerEventHandler ","title":"onPointerMove"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointermovecapture","text":"\u2022 Optional onPointerMoveCapture : PointerEventHandler ","title":"onPointerMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerout","text":"\u2022 Optional onPointerOut : PointerEventHandler ","title":"onPointerOut"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointeroutcapture","text":"\u2022 Optional onPointerOutCapture : PointerEventHandler ","title":"onPointerOutCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerover","text":"\u2022 Optional onPointerOver : PointerEventHandler ","title":"onPointerOver"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerovercapture","text":"\u2022 Optional onPointerOverCapture : PointerEventHandler ","title":"onPointerOverCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerup","text":"\u2022 Optional onPointerUp : PointerEventHandler ","title":"onPointerUp"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onpointerupcapture","text":"\u2022 Optional onPointerUpCapture : PointerEventHandler ","title":"onPointerUpCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onprogress","text":"\u2022 Optional onProgress : ReactEventHandler ","title":"onProgress"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onprogresscapture","text":"\u2022 Optional onProgressCapture : ReactEventHandler ","title":"onProgressCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onratechange","text":"\u2022 Optional onRateChange : ReactEventHandler ","title":"onRateChange"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onratechangecapture","text":"\u2022 Optional onRateChangeCapture : ReactEventHandler ","title":"onRateChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onreset","text":"\u2022 Optional onReset : FormEventHandler ","title":"onReset"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onresetcapture","text":"\u2022 Optional onResetCapture : FormEventHandler ","title":"onResetCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onscroll","text":"\u2022 Optional onScroll : UIEventHandler ","title":"onScroll"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onscrollcapture","text":"\u2022 Optional onScrollCapture : UIEventHandler ","title":"onScrollCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onseeked","text":"\u2022 Optional onSeeked : ReactEventHandler ","title":"onSeeked"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onseekedcapture","text":"\u2022 Optional onSeekedCapture : ReactEventHandler ","title":"onSeekedCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onseeking","text":"\u2022 Optional onSeeking : ReactEventHandler ","title":"onSeeking"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onseekingcapture","text":"\u2022 Optional onSeekingCapture : ReactEventHandler ","title":"onSeekingCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onselect","text":"\u2022 Optional onSelect : ReactEventHandler ","title":"onSelect"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onselectcapture","text":"\u2022 Optional onSelectCapture : ReactEventHandler ","title":"onSelectCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onstalled","text":"\u2022 Optional onStalled : ReactEventHandler ","title":"onStalled"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onstalledcapture","text":"\u2022 Optional onStalledCapture : ReactEventHandler ","title":"onStalledCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onsubmit","text":"\u2022 Optional onSubmit : FormEventHandler ","title":"onSubmit"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onsubmitcapture","text":"\u2022 Optional onSubmitCapture : FormEventHandler ","title":"onSubmitCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onsuspend","text":"\u2022 Optional onSuspend : ReactEventHandler ","title":"onSuspend"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onsuspendcapture","text":"\u2022 Optional onSuspendCapture : ReactEventHandler ","title":"onSuspendCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontimeupdate","text":"\u2022 Optional onTimeUpdate : ReactEventHandler ","title":"onTimeUpdate"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontimeupdatecapture","text":"\u2022 Optional onTimeUpdateCapture : ReactEventHandler ","title":"onTimeUpdateCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchcancel","text":"\u2022 Optional onTouchCancel : TouchEventHandler ","title":"onTouchCancel"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchcancelcapture","text":"\u2022 Optional onTouchCancelCapture : TouchEventHandler ","title":"onTouchCancelCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchend","text":"\u2022 Optional onTouchEnd : TouchEventHandler ","title":"onTouchEnd"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchendcapture","text":"\u2022 Optional onTouchEndCapture : TouchEventHandler ","title":"onTouchEndCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchmove","text":"\u2022 Optional onTouchMove : TouchEventHandler ","title":"onTouchMove"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchmovecapture","text":"\u2022 Optional onTouchMoveCapture : TouchEventHandler ","title":"onTouchMoveCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchstart","text":"\u2022 Optional onTouchStart : TouchEventHandler ","title":"onTouchStart"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontouchstartcapture","text":"\u2022 Optional onTouchStartCapture : TouchEventHandler ","title":"onTouchStartCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontransitionend","text":"\u2022 Optional onTransitionEnd : TransitionEventHandler ","title":"onTransitionEnd"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#ontransitionendcapture","text":"\u2022 Optional onTransitionEndCapture : TransitionEventHandler ","title":"onTransitionEndCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onvolumechange","text":"\u2022 Optional onVolumeChange : ReactEventHandler ","title":"onVolumeChange"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onvolumechangecapture","text":"\u2022 Optional onVolumeChangeCapture : ReactEventHandler ","title":"onVolumeChangeCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onwaiting","text":"\u2022 Optional onWaiting : ReactEventHandler ","title":"onWaiting"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onwaitingcapture","text":"\u2022 Optional onWaitingCapture : ReactEventHandler ","title":"onWaitingCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onwheel","text":"\u2022 Optional onWheel : WheelEventHandler ","title":"onWheel"},{"location":"extensions/api/interfaces/renderer.component.wizardlayoutprops/#onwheelcapture","text":"\u2022 Optional onWheelCapture : WheelEventHandler ","title":"onWheelCapture"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/","text":"Interface: WizardProps # Renderer . Component .WizardProps Hierarchy # WizardCommonProps \u21b3 WizardProps Table of contents # Properties # className data done header hideSteps onChange reset save step title Properties # className # \u2022 Optional className : string data # \u2022 Optional data : Partial Inherited from # WizardCommonProps.data done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps.done header # \u2022 Optional header : ReactNode hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps.hideSteps onChange # \u2022 Optional onChange : ( step : number ) => void Type declaration # \u25b8 ( step ): void Parameters # Name Type step number Returns # void reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps.reset save # \u2022 Optional save : ( data : Partial , callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial callback? () => void Returns # void Inherited from # WizardCommonProps.save step # \u2022 Optional step : number title # \u2022 Optional title : string","title":"Interface: WizardProps"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#interface-wizardprops","text":"Renderer . Component .WizardProps","title":"Interface: WizardProps"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#hierarchy","text":"WizardCommonProps \u21b3 WizardProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#properties","text":"className data done header hideSteps onChange reset save step title","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#data","text":"\u2022 Optional data : Partial ","title":"data"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#onchange","text":"\u2022 Optional onChange : ( step : number ) => void","title":"onChange"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#save","text":"\u2022 Optional save : ( data : Partial , callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.wizardprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/","text":"Interface: WizardStepProps # Renderer . Component .WizardStepProps Type parameters # Name Type D D = any Hierarchy # WizardCommonProps \u21b3 WizardStepProps Table of contents # Properties # afterContent beforeContent className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step title waiting wizard Properties # afterContent # \u2022 Optional afterContent : ReactNode beforeContent # \u2022 Optional beforeContent : ReactNode className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object customButtons # \u2022 Optional customButtons : ReactNode data # \u2022 Optional data : Partial Inherited from # WizardCommonProps.data disabledNext # \u2022 Optional disabledNext : boolean done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps.done first # \u2022 Optional first : () => void Type declaration # \u25b8 (): void Returns # void hideBackBtn # \u2022 Optional hideBackBtn : boolean hideNextBtn # \u2022 Optional hideNextBtn : boolean hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps.hideSteps isFirst # \u2022 Optional isFirst : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean isLast # \u2022 Optional isLast : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean last # \u2022 Optional last : () => void Type declaration # \u25b8 (): void Returns # void loading # \u2022 Optional loading : boolean moreButtons # \u2022 Optional moreButtons : ReactNode next # \u2022 Optional next : () => boolean | void | Promise Type declaration # \u25b8 (): boolean | void | Promise Returns # boolean | void | Promise nextLabel # \u2022 Optional nextLabel : ReactNode noValidate # \u2022 Optional noValidate : boolean prev # \u2022 Optional prev : () => void Type declaration # \u25b8 (): void Returns # void prevLabel # \u2022 Optional prevLabel : ReactNode reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps.reset save # \u2022 Optional save : ( data : Partial , callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial callback? () => void Returns # void Inherited from # WizardCommonProps.save scrollable # \u2022 Optional scrollable : boolean skip # \u2022 Optional skip : boolean step # \u2022 Optional step : number title # \u2022 Optional title : string waiting # \u2022 Optional waiting : boolean wizard # \u2022 Optional wizard : Wizard","title":"Interface: WizardStepProps"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#interface-wizardsteppropsd","text":"Renderer . Component .WizardStepProps","title":"Interface: WizardStepProps<D>"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#type-parameters","text":"Name Type D D = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#hierarchy","text":"WizardCommonProps \u21b3 WizardStepProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#properties","text":"afterContent beforeContent className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step title waiting wizard","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#aftercontent","text":"\u2022 Optional afterContent : ReactNode","title":"afterContent"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#beforecontent","text":"\u2022 Optional beforeContent : ReactNode","title":"beforeContent"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#custombuttons","text":"\u2022 Optional customButtons : ReactNode","title":"customButtons"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#data","text":"\u2022 Optional data : Partial ","title":"data"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#disablednext","text":"\u2022 Optional disabledNext : boolean","title":"disabledNext"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#first","text":"\u2022 Optional first : () => void","title":"first"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#hidebackbtn","text":"\u2022 Optional hideBackBtn : boolean","title":"hideBackBtn"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#hidenextbtn","text":"\u2022 Optional hideNextBtn : boolean","title":"hideNextBtn"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#isfirst","text":"\u2022 Optional isFirst : () => boolean","title":"isFirst"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#islast","text":"\u2022 Optional isLast : () => boolean","title":"isLast"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#last","text":"\u2022 Optional last : () => void","title":"last"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#loading","text":"\u2022 Optional loading : boolean","title":"loading"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#morebuttons","text":"\u2022 Optional moreButtons : ReactNode","title":"moreButtons"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#next","text":"\u2022 Optional next : () => boolean | void | Promise ","title":"next"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#nextlabel","text":"\u2022 Optional nextLabel : ReactNode","title":"nextLabel"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#prev","text":"\u2022 Optional prev : () => void","title":"prev"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#prevlabel","text":"\u2022 Optional prevLabel : ReactNode","title":"prevLabel"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#save","text":"\u2022 Optional save : ( data : Partial , callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#skip","text":"\u2022 Optional skip : boolean","title":"skip"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/renderer.component.wizardstepprops/#wizard","text":"\u2022 Optional wizard : Wizard","title":"wizard"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/","text":"Interface: IKubeApiCluster # Renderer . K8sApi .IKubeApiCluster Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/#interface-ikubeapicluster","text":"Renderer . K8sApi .IKubeApiCluster","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/","text":"Interface: IPodContainer # Renderer . K8sApi .IPodContainer Table of contents # Properties # args command env envFrom image imagePullPolicy livenessProbe name ports readinessProbe resources startupProbe volumeMounts Properties # args # \u2022 Optional args : string [] command # \u2022 Optional command : string [] env # \u2022 Optional env : { name : string ; value? : string ; valueFrom? : { configMapKeyRef? : { key : string ; name : string } ; fieldRef? : { apiVersion : string ; fieldPath : string } ; secretKeyRef? : { key : string ; name : string } } }[] envFrom # \u2022 Optional envFrom : { configMapRef? : { name : string } ; secretRef? : { name : string } }[] image # \u2022 image : string imagePullPolicy # \u2022 imagePullPolicy : string livenessProbe # \u2022 Optional livenessProbe : IContainerProbe name # \u2022 name : string ports # \u2022 Optional ports : { containerPort : number ; name? : string ; protocol : string }[] readinessProbe # \u2022 Optional readinessProbe : IContainerProbe resources # \u2022 Optional resources : Object Type declaration # Name Type limits Object limits.cpu string limits.memory string requests Object requests.cpu string requests.memory string startupProbe # \u2022 Optional startupProbe : IContainerProbe volumeMounts # \u2022 Optional volumeMounts : { mountPath : string ; name : string ; readOnly : boolean }[]","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#interface-ipodcontainer","text":"Renderer . K8sApi .IPodContainer","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#properties","text":"args command env envFrom image imagePullPolicy livenessProbe name ports readinessProbe resources startupProbe volumeMounts","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#args","text":"\u2022 Optional args : string []","title":"args"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#command","text":"\u2022 Optional command : string []","title":"command"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#env","text":"\u2022 Optional env : { name : string ; value? : string ; valueFrom? : { configMapKeyRef? : { key : string ; name : string } ; fieldRef? : { apiVersion : string ; fieldPath : string } ; secretKeyRef? : { key : string ; name : string } } }[]","title":"env"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#envfrom","text":"\u2022 Optional envFrom : { configMapRef? : { name : string } ; secretRef? : { name : string } }[]","title":"envFrom"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#image","text":"\u2022 image : string","title":"image"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#imagepullpolicy","text":"\u2022 imagePullPolicy : string","title":"imagePullPolicy"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#livenessprobe","text":"\u2022 Optional livenessProbe : IContainerProbe","title":"livenessProbe"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#ports","text":"\u2022 Optional ports : { containerPort : number ; name? : string ; protocol : string }[]","title":"ports"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#readinessprobe","text":"\u2022 Optional readinessProbe : IContainerProbe","title":"readinessProbe"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#resources","text":"\u2022 Optional resources : Object","title":"resources"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#startupprobe","text":"\u2022 Optional startupProbe : IContainerProbe","title":"startupProbe"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainer/#volumemounts","text":"\u2022 Optional volumeMounts : { mountPath : string ; name : string ; readOnly : boolean }[]","title":"volumeMounts"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/","text":"Interface: IPodContainerStatus # Renderer . K8sApi .IPodContainerStatus Table of contents # Properties # containerID image imageID lastState name ready restartCount started state Properties # containerID # \u2022 Optional containerID : string image # \u2022 image : string imageID # \u2022 imageID : string lastState # \u2022 Optional lastState : Object Index signature # \u25aa [index: string ]: object Type declaration # Name Type running? Object running.startedAt string terminated? Object terminated.exitCode number terminated.finishedAt string terminated.reason string terminated.startedAt string waiting? Object waiting.message string waiting.reason string name # \u2022 name : string ready # \u2022 ready : boolean restartCount # \u2022 restartCount : number started # \u2022 Optional started : boolean state # \u2022 Optional state : Object Index signature # \u25aa [index: string ]: object Type declaration # Name Type running? Object running.startedAt string terminated? Object terminated.exitCode number terminated.finishedAt string terminated.reason string terminated.startedAt string waiting? Object waiting.message string waiting.reason string","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#interface-ipodcontainerstatus","text":"Renderer . K8sApi .IPodContainerStatus","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#properties","text":"containerID image imageID lastState name ready restartCount started state","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#containerid","text":"\u2022 Optional containerID : string","title":"containerID"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#image","text":"\u2022 image : string","title":"image"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#imageid","text":"\u2022 imageID : string","title":"imageID"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#laststate","text":"\u2022 Optional lastState : Object","title":"lastState"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#ready","text":"\u2022 ready : boolean","title":"ready"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#restartcount","text":"\u2022 restartCount : number","title":"restartCount"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#started","text":"\u2022 Optional started : boolean","title":"started"},{"location":"extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/#state","text":"\u2022 Optional state : Object","title":"state"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/","text":"Interface: ISecretRef # Renderer . K8sApi .ISecretRef Table of contents # Properties # key name Properties # key # \u2022 Optional key : string name # \u2022 name : string","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#interface-isecretref","text":"Renderer . K8sApi .ISecretRef","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#properties","text":"key name","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#key","text":"\u2022 Optional key : string","title":"key"},{"location":"extensions/api/interfaces/renderer.k8sapi.isecretref/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/","text":"Interface: PageParamInit # Renderer . Navigation .PageParamInit Type parameters # Name Type V V = any Table of contents # Properties # defaultValue name prefix Methods # parse stringify Properties # defaultValue # \u2022 Optional defaultValue : V name # \u2022 name : string prefix # \u2022 Optional prefix : string Methods # parse # \u25b8 Optional parse ( value ): V Parameters # Name Type value string | string [] Returns # V stringify # \u25b8 Optional stringify ( value ): string | string [] Parameters # Name Type value V Returns # string | string []","title":"Interface: PageParamInit"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#interface-pageparaminitv","text":"Renderer . Navigation .PageParamInit","title":"Interface: PageParamInit<V>"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#type-parameters","text":"Name Type V V = any","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#properties","text":"defaultValue name prefix","title":"Properties"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#methods","text":"parse stringify","title":"Methods"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#defaultvalue","text":"\u2022 Optional defaultValue : V","title":"defaultValue"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#prefix","text":"\u2022 Optional prefix : string","title":"prefix"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#parse","text":"\u25b8 Optional parse ( value ): V","title":"parse"},{"location":"extensions/api/interfaces/renderer.navigation.pageparaminit/#stringify","text":"\u25b8 Optional stringify ( value ): string | string []","title":"stringify"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/","text":"Interface: URLParams # Renderer . Navigation .URLParams Type parameters # Name Type P P : object = {} Q Q : object = {} Table of contents # Properties # fragment params query Properties # fragment # \u2022 Optional fragment : string params # \u2022 Optional params : P query # \u2022 Optional query : Q","title":"Interface: URLParams"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#interface-urlparamsp-q","text":"Renderer . Navigation .URLParams","title":"Interface: URLParams<P, Q>"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#type-parameters","text":"Name Type P P : object = {} Q Q : object = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#properties","text":"fragment params query","title":"Properties"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#fragment","text":"\u2022 Optional fragment : string","title":"fragment"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#params","text":"\u2022 Optional params : P","title":"params"},{"location":"extensions/api/interfaces/renderer.navigation.urlparams/#query","text":"\u2022 Optional query : Q","title":"query"},{"location":"extensions/api/modules/common.app/","text":"Namespace: App # Common .App Table of contents # Variables # appName isLinux isMac isSnap isWindows issuesTrackerUrl slackUrl version Functions # getEnabledExtensions Variables # appName # \u2022 Const appName : string isLinux # \u2022 Const isLinux : boolean isMac # \u2022 Const isMac : boolean isSnap # \u2022 Const isSnap : boolean = !!process.env.SNAP isWindows # \u2022 Const isWindows : boolean issuesTrackerUrl # \u2022 Const issuesTrackerUrl : string slackUrl # \u2022 Const slackUrl : string version # \u2022 Const version : string Functions # getEnabledExtensions # \u25b8 getEnabledExtensions (): string [] Returns # string []","title":"Namespace: App"},{"location":"extensions/api/modules/common.app/#namespace-app","text":"Common .App","title":"Namespace: App"},{"location":"extensions/api/modules/common.app/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.app/#variables","text":"appName isLinux isMac isSnap isWindows issuesTrackerUrl slackUrl version","title":"Variables"},{"location":"extensions/api/modules/common.app/#functions","text":"getEnabledExtensions","title":"Functions"},{"location":"extensions/api/modules/common.app/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/common.app/#appname","text":"\u2022 Const appName : string","title":"appName"},{"location":"extensions/api/modules/common.app/#islinux","text":"\u2022 Const isLinux : boolean","title":"isLinux"},{"location":"extensions/api/modules/common.app/#ismac","text":"\u2022 Const isMac : boolean","title":"isMac"},{"location":"extensions/api/modules/common.app/#issnap","text":"\u2022 Const isSnap : boolean = !!process.env.SNAP","title":"isSnap"},{"location":"extensions/api/modules/common.app/#iswindows","text":"\u2022 Const isWindows : boolean","title":"isWindows"},{"location":"extensions/api/modules/common.app/#issuestrackerurl","text":"\u2022 Const issuesTrackerUrl : string","title":"issuesTrackerUrl"},{"location":"extensions/api/modules/common.app/#slackurl","text":"\u2022 Const slackUrl : string","title":"slackUrl"},{"location":"extensions/api/modules/common.app/#version","text":"\u2022 Const version : string","title":"version"},{"location":"extensions/api/modules/common.app/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/common.app/#getenabledextensions","text":"\u25b8 getEnabledExtensions (): string []","title":"getEnabledExtensions"},{"location":"extensions/api/modules/common.catalog/","text":"Namespace: Catalog # Common .Catalog Table of contents # Classes # CatalogCategory CatalogEntity GeneralCategory GeneralEntity KubernetesCluster WebLink WebLinkCategory Interfaces # CatalogCategoryEvents CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus WebLinkStatus Type aliases # CatalogEntityConstructor CatalogEntitySpec KubernetesClusterStatusPhase WebLinkSpec WebLinkStatusPhase Variables # kubernetesClusterCategory Type aliases # CatalogEntityConstructor # \u01ac CatalogEntityConstructor : ( data : CatalogEntityData , ExtractEntityStatusType, ExtractEntitySpecType \\>) => Entity Type parameters # Name Type Entity Entity : CatalogEntity Type declaration # \u2022 ( data ) Parameters # Name Type data CatalogEntityData , ExtractEntityStatusType, ExtractEntitySpecType> CatalogEntitySpec # \u01ac CatalogEntitySpec : Record KubernetesClusterStatusPhase # \u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\" WebLinkSpec # \u01ac WebLinkSpec : Object Type declaration # Name Type url string WebLinkStatusPhase # \u01ac WebLinkStatusPhase : \"available\" | \"unavailable\" Variables # kubernetesClusterCategory # \u2022 Const kubernetesClusterCategory : KubernetesClusterCategory","title":"Namespace: Catalog"},{"location":"extensions/api/modules/common.catalog/#namespace-catalog","text":"Common .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/common.catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.catalog/#classes","text":"CatalogCategory CatalogEntity GeneralCategory GeneralEntity KubernetesCluster WebLink WebLinkCategory","title":"Classes"},{"location":"extensions/api/modules/common.catalog/#interfaces","text":"CatalogCategoryEvents CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus WebLinkStatus","title":"Interfaces"},{"location":"extensions/api/modules/common.catalog/#type-aliases","text":"CatalogEntityConstructor CatalogEntitySpec KubernetesClusterStatusPhase WebLinkSpec WebLinkStatusPhase","title":"Type aliases"},{"location":"extensions/api/modules/common.catalog/#variables","text":"kubernetesClusterCategory","title":"Variables"},{"location":"extensions/api/modules/common.catalog/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/common.catalog/#catalogentityconstructor","text":"\u01ac CatalogEntityConstructor : ( data : CatalogEntityData , ExtractEntityStatusType, ExtractEntitySpecType \\>) => Entity","title":"CatalogEntityConstructor"},{"location":"extensions/api/modules/common.catalog/#catalogentityspec","text":"\u01ac CatalogEntitySpec : Record ","title":"CatalogEntitySpec"},{"location":"extensions/api/modules/common.catalog/#kubernetesclusterstatusphase","text":"\u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\"","title":"KubernetesClusterStatusPhase"},{"location":"extensions/api/modules/common.catalog/#weblinkspec","text":"\u01ac WebLinkSpec : Object","title":"WebLinkSpec"},{"location":"extensions/api/modules/common.catalog/#weblinkstatusphase","text":"\u01ac WebLinkStatusPhase : \"available\" | \"unavailable\"","title":"WebLinkStatusPhase"},{"location":"extensions/api/modules/common.catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/common.catalog/#kubernetesclustercategory","text":"\u2022 Const kubernetesClusterCategory : KubernetesClusterCategory","title":"kubernetesClusterCategory"},{"location":"extensions/api/modules/common.eventbus/","text":"Namespace: EventBus # Common .EventBus Table of contents # Type aliases # AppEvent Variables # appEventBus Type aliases # AppEvent # \u01ac AppEvent : Object Type declaration # Name Type action string name string params? object Variables # appEventBus # \u2022 Const appEventBus : EventEmitter <[ AppEvent ]> Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Namespace: EventBus"},{"location":"extensions/api/modules/common.eventbus/#namespace-eventbus","text":"Common .EventBus","title":"Namespace: EventBus"},{"location":"extensions/api/modules/common.eventbus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.eventbus/#type-aliases","text":"AppEvent","title":"Type aliases"},{"location":"extensions/api/modules/common.eventbus/#variables","text":"appEventBus","title":"Variables"},{"location":"extensions/api/modules/common.eventbus/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/common.eventbus/#appevent","text":"\u01ac AppEvent : Object","title":"AppEvent"},{"location":"extensions/api/modules/common.eventbus/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/common.eventbus/#appeventbus","text":"\u2022 Const appEventBus : EventEmitter <[ AppEvent ]> Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"appEventBus"},{"location":"extensions/api/modules/common/","text":"Namespace: Common # Table of contents # Namespaces # App Catalog EventBus Store Types Util Variables # logger Variables # logger # \u2022 logger : Logger","title":"Namespace: Common"},{"location":"extensions/api/modules/common/#namespace-common","text":"","title":"Namespace: Common"},{"location":"extensions/api/modules/common/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common/#namespaces","text":"App Catalog EventBus Store Types Util","title":"Namespaces"},{"location":"extensions/api/modules/common/#variables","text":"logger","title":"Variables"},{"location":"extensions/api/modules/common/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/common/#logger","text":"\u2022 logger : Logger","title":"logger"},{"location":"extensions/api/modules/common.store/","text":"Namespace: Store # Common .Store Table of contents # Classes # ExtensionStore","title":"Namespace: Store"},{"location":"extensions/api/modules/common.store/#namespace-store","text":"Common .Store","title":"Namespace: Store"},{"location":"extensions/api/modules/common.store/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.store/#classes","text":"ExtensionStore","title":"Classes"},{"location":"extensions/api/modules/common.types/","text":"Namespace: Types # Common .Types Table of contents # Interfaces # AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage StatusBarRegistration Type aliases # IpcMainEvent IpcMainInvokeEvent IpcRendererEvent Type aliases # IpcMainEvent # \u01ac IpcMainEvent : Electron.IpcMainEvent IpcMainInvokeEvent # \u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. IpcRendererEvent # \u01ac IpcRendererEvent : Electron.IpcRendererEvent","title":"Namespace: Types"},{"location":"extensions/api/modules/common.types/#namespace-types","text":"Common .Types","title":"Namespace: Types"},{"location":"extensions/api/modules/common.types/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.types/#interfaces","text":"AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage StatusBarRegistration","title":"Interfaces"},{"location":"extensions/api/modules/common.types/#type-aliases","text":"IpcMainEvent IpcMainInvokeEvent IpcRendererEvent","title":"Type aliases"},{"location":"extensions/api/modules/common.types/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/common.types/#ipcmainevent","text":"\u01ac IpcMainEvent : Electron.IpcMainEvent","title":"IpcMainEvent"},{"location":"extensions/api/modules/common.types/#ipcmaininvokeevent","text":"\u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"IpcMainInvokeEvent"},{"location":"extensions/api/modules/common.types/#ipcrendererevent","text":"\u01ac IpcRendererEvent : Electron.IpcRendererEvent","title":"IpcRendererEvent"},{"location":"extensions/api/modules/common.util/","text":"Namespace: Util # Common .Util Table of contents # Classes # Singleton Functions # cssNames openExternal prevDefault stopPropagation Functions # cssNames # \u25b8 cssNames (... args ): string Parameters # Name Type ...args IClassName [] Returns # string openExternal # \u25b8 openExternal ( url ): Promise Parameters # Name Type url string Returns # Promise prevDefault # \u25b8 prevDefault ( callback ): ( evt : E ) => any Type parameters # Name Type E E : Event | SyntheticEvent Parameters # Name Type callback ( evt : E ) => any Returns # fn \u25b8 ( evt ): any Parameters # Name Type evt E Returns # any stopPropagation # \u25b8 stopPropagation ( evt ): void Parameters # Name Type evt Event | React.SyntheticEvent Returns # void","title":"Namespace: Util"},{"location":"extensions/api/modules/common.util/#namespace-util","text":"Common .Util","title":"Namespace: Util"},{"location":"extensions/api/modules/common.util/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/common.util/#classes","text":"Singleton","title":"Classes"},{"location":"extensions/api/modules/common.util/#functions","text":"cssNames openExternal prevDefault stopPropagation","title":"Functions"},{"location":"extensions/api/modules/common.util/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/common.util/#cssnames","text":"\u25b8 cssNames (... args ): string","title":"cssNames"},{"location":"extensions/api/modules/common.util/#openexternal","text":"\u25b8 openExternal ( url ): Promise ","title":"openExternal"},{"location":"extensions/api/modules/common.util/#prevdefault","text":"\u25b8 prevDefault ( callback ): ( evt : E ) => any","title":"prevDefault"},{"location":"extensions/api/modules/common.util/#stoppropagation","text":"\u25b8 stopPropagation ( evt ): void","title":"stopPropagation"},{"location":"extensions/api/modules/main.catalog/","text":"Namespace: Catalog # Main .Catalog Table of contents # References # catalogCategories Classes # CatalogEntityRegistry Variables # catalogEntities References # catalogCategories # Re-exports: catalogCategories Variables # catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/main.catalog/#namespace-catalog","text":"Main .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/main.catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/main.catalog/#references","text":"catalogCategories","title":"References"},{"location":"extensions/api/modules/main.catalog/#classes","text":"CatalogEntityRegistry","title":"Classes"},{"location":"extensions/api/modules/main.catalog/#variables","text":"catalogEntities","title":"Variables"},{"location":"extensions/api/modules/main.catalog/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/main.catalog/#catalogcategories","text":"Re-exports: catalogCategories","title":"catalogCategories"},{"location":"extensions/api/modules/main.catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/main.catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/main.k8sapi/","text":"Namespace: K8sApi # Main .K8sApi Table of contents # References # ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment DeploymentApi Endpoint HorizontalPodAutoscaler IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Ingress IngressApi Job KubeApi KubeEvent KubeObject KubeObjectStore LimitRange Namespace NetworkPolicy Node NodesApi PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi Pod PodDisruptionBudget PodsApi ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi forCluster hpaApi ingressApi isAllowedResource jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi References # ClusterRole # Re-exports: ClusterRole ClusterRoleBinding # Re-exports: ClusterRoleBinding ConfigMap # Re-exports: ConfigMap CronJob # Re-exports: CronJob CustomResourceDefinition # Re-exports: CustomResourceDefinition DaemonSet # Re-exports: DaemonSet Deployment # Re-exports: Deployment DeploymentApi # Re-exports: DeploymentApi Endpoint # Re-exports: Endpoint HorizontalPodAutoscaler # Re-exports: HorizontalPodAutoscaler IKubeApiCluster # Re-exports: IKubeApiCluster IPodContainer # Re-exports: IPodContainer IPodContainerStatus # Re-exports: IPodContainerStatus ISecretRef # Re-exports: ISecretRef Ingress # Re-exports: Ingress IngressApi # Re-exports: IngressApi Job # Re-exports: Job KubeApi # Re-exports: KubeApi KubeEvent # Re-exports: KubeEvent KubeObject # Re-exports: KubeObject KubeObjectStore # Re-exports: KubeObjectStore LimitRange # Re-exports: LimitRange Namespace # Re-exports: Namespace NetworkPolicy # Re-exports: NetworkPolicy Node # Re-exports: Node NodesApi # Re-exports: NodesApi PersistentVolume # Re-exports: PersistentVolume PersistentVolumeClaim # Re-exports: PersistentVolumeClaim PersistentVolumeClaimsApi # Re-exports: PersistentVolumeClaimsApi Pod # Re-exports: Pod PodDisruptionBudget # Re-exports: PodDisruptionBudget PodsApi # Re-exports: PodsApi ReplicaSet # Re-exports: ReplicaSet ResourceQuota # Re-exports: ResourceQuota ResourceStack # Re-exports: ResourceStack Role # Re-exports: Role RoleBinding # Re-exports: RoleBinding Secret # Re-exports: Secret Service # Re-exports: Service ServiceAccount # Re-exports: ServiceAccount StatefulSet # Re-exports: StatefulSet StorageClass # Re-exports: StorageClass apiManager # Re-exports: apiManager clusterRoleApi # Re-exports: clusterRoleApi clusterRoleBindingApi # Re-exports: clusterRoleBindingApi configMapApi # Re-exports: configMapApi crdApi # Re-exports: crdApi cronJobApi # Re-exports: cronJobApi daemonSetApi # Re-exports: daemonSetApi deploymentApi # Re-exports: deploymentApi endpointApi # Re-exports: endpointApi eventApi # Re-exports: eventApi forCluster # Re-exports: forCluster hpaApi # Re-exports: hpaApi ingressApi # Re-exports: ingressApi isAllowedResource # Re-exports: isAllowedResource jobApi # Re-exports: jobApi limitRangeApi # Re-exports: limitRangeApi namespacesApi # Re-exports: namespacesApi networkPolicyApi # Re-exports: networkPolicyApi nodesApi # Re-exports: nodesApi pdbApi # Re-exports: pdbApi persistentVolumeApi # Re-exports: persistentVolumeApi podsApi # Re-exports: podsApi pvcApi # Re-exports: pvcApi replicaSetApi # Re-exports: replicaSetApi resourceQuotaApi # Re-exports: resourceQuotaApi roleApi # Re-exports: roleApi roleBindingApi # Re-exports: roleBindingApi secretsApi # Re-exports: secretsApi serviceAccountsApi # Re-exports: serviceAccountsApi serviceApi # Re-exports: serviceApi statefulSetApi # Re-exports: statefulSetApi storageClassApi # Re-exports: storageClassApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/main.k8sapi/#namespace-k8sapi","text":"Main .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/main.k8sapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/main.k8sapi/#references","text":"ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment DeploymentApi Endpoint HorizontalPodAutoscaler IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Ingress IngressApi Job KubeApi KubeEvent KubeObject KubeObjectStore LimitRange Namespace NetworkPolicy Node NodesApi PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi Pod PodDisruptionBudget PodsApi ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi forCluster hpaApi ingressApi isAllowedResource jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"References"},{"location":"extensions/api/modules/main.k8sapi/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/main.k8sapi/#clusterrole","text":"Re-exports: ClusterRole","title":"ClusterRole"},{"location":"extensions/api/modules/main.k8sapi/#clusterrolebinding","text":"Re-exports: ClusterRoleBinding","title":"ClusterRoleBinding"},{"location":"extensions/api/modules/main.k8sapi/#configmap","text":"Re-exports: ConfigMap","title":"ConfigMap"},{"location":"extensions/api/modules/main.k8sapi/#cronjob","text":"Re-exports: CronJob","title":"CronJob"},{"location":"extensions/api/modules/main.k8sapi/#customresourcedefinition","text":"Re-exports: CustomResourceDefinition","title":"CustomResourceDefinition"},{"location":"extensions/api/modules/main.k8sapi/#daemonset","text":"Re-exports: DaemonSet","title":"DaemonSet"},{"location":"extensions/api/modules/main.k8sapi/#deployment","text":"Re-exports: Deployment","title":"Deployment"},{"location":"extensions/api/modules/main.k8sapi/#deploymentapi","text":"Re-exports: DeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/main.k8sapi/#endpoint","text":"Re-exports: Endpoint","title":"Endpoint"},{"location":"extensions/api/modules/main.k8sapi/#horizontalpodautoscaler","text":"Re-exports: HorizontalPodAutoscaler","title":"HorizontalPodAutoscaler"},{"location":"extensions/api/modules/main.k8sapi/#ikubeapicluster","text":"Re-exports: IKubeApiCluster","title":"IKubeApiCluster"},{"location":"extensions/api/modules/main.k8sapi/#ipodcontainer","text":"Re-exports: IPodContainer","title":"IPodContainer"},{"location":"extensions/api/modules/main.k8sapi/#ipodcontainerstatus","text":"Re-exports: IPodContainerStatus","title":"IPodContainerStatus"},{"location":"extensions/api/modules/main.k8sapi/#isecretref","text":"Re-exports: ISecretRef","title":"ISecretRef"},{"location":"extensions/api/modules/main.k8sapi/#ingress","text":"Re-exports: Ingress","title":"Ingress"},{"location":"extensions/api/modules/main.k8sapi/#ingressapi","text":"Re-exports: IngressApi","title":"IngressApi"},{"location":"extensions/api/modules/main.k8sapi/#job","text":"Re-exports: Job","title":"Job"},{"location":"extensions/api/modules/main.k8sapi/#kubeapi","text":"Re-exports: KubeApi","title":"KubeApi"},{"location":"extensions/api/modules/main.k8sapi/#kubeevent","text":"Re-exports: KubeEvent","title":"KubeEvent"},{"location":"extensions/api/modules/main.k8sapi/#kubeobject","text":"Re-exports: KubeObject","title":"KubeObject"},{"location":"extensions/api/modules/main.k8sapi/#kubeobjectstore","text":"Re-exports: KubeObjectStore","title":"KubeObjectStore"},{"location":"extensions/api/modules/main.k8sapi/#limitrange","text":"Re-exports: LimitRange","title":"LimitRange"},{"location":"extensions/api/modules/main.k8sapi/#namespace","text":"Re-exports: Namespace","title":"Namespace"},{"location":"extensions/api/modules/main.k8sapi/#networkpolicy","text":"Re-exports: NetworkPolicy","title":"NetworkPolicy"},{"location":"extensions/api/modules/main.k8sapi/#node","text":"Re-exports: Node","title":"Node"},{"location":"extensions/api/modules/main.k8sapi/#nodesapi","text":"Re-exports: NodesApi","title":"NodesApi"},{"location":"extensions/api/modules/main.k8sapi/#persistentvolume","text":"Re-exports: PersistentVolume","title":"PersistentVolume"},{"location":"extensions/api/modules/main.k8sapi/#persistentvolumeclaim","text":"Re-exports: PersistentVolumeClaim","title":"PersistentVolumeClaim"},{"location":"extensions/api/modules/main.k8sapi/#persistentvolumeclaimsapi","text":"Re-exports: PersistentVolumeClaimsApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/main.k8sapi/#pod","text":"Re-exports: Pod","title":"Pod"},{"location":"extensions/api/modules/main.k8sapi/#poddisruptionbudget","text":"Re-exports: PodDisruptionBudget","title":"PodDisruptionBudget"},{"location":"extensions/api/modules/main.k8sapi/#podsapi","text":"Re-exports: PodsApi","title":"PodsApi"},{"location":"extensions/api/modules/main.k8sapi/#replicaset","text":"Re-exports: ReplicaSet","title":"ReplicaSet"},{"location":"extensions/api/modules/main.k8sapi/#resourcequota","text":"Re-exports: ResourceQuota","title":"ResourceQuota"},{"location":"extensions/api/modules/main.k8sapi/#resourcestack","text":"Re-exports: ResourceStack","title":"ResourceStack"},{"location":"extensions/api/modules/main.k8sapi/#role","text":"Re-exports: Role","title":"Role"},{"location":"extensions/api/modules/main.k8sapi/#rolebinding","text":"Re-exports: RoleBinding","title":"RoleBinding"},{"location":"extensions/api/modules/main.k8sapi/#secret","text":"Re-exports: Secret","title":"Secret"},{"location":"extensions/api/modules/main.k8sapi/#service","text":"Re-exports: Service","title":"Service"},{"location":"extensions/api/modules/main.k8sapi/#serviceaccount","text":"Re-exports: ServiceAccount","title":"ServiceAccount"},{"location":"extensions/api/modules/main.k8sapi/#statefulset","text":"Re-exports: StatefulSet","title":"StatefulSet"},{"location":"extensions/api/modules/main.k8sapi/#storageclass","text":"Re-exports: StorageClass","title":"StorageClass"},{"location":"extensions/api/modules/main.k8sapi/#apimanager","text":"Re-exports: apiManager","title":"apiManager"},{"location":"extensions/api/modules/main.k8sapi/#clusterroleapi","text":"Re-exports: clusterRoleApi","title":"clusterRoleApi"},{"location":"extensions/api/modules/main.k8sapi/#clusterrolebindingapi","text":"Re-exports: clusterRoleBindingApi","title":"clusterRoleBindingApi"},{"location":"extensions/api/modules/main.k8sapi/#configmapapi","text":"Re-exports: configMapApi","title":"configMapApi"},{"location":"extensions/api/modules/main.k8sapi/#crdapi","text":"Re-exports: crdApi","title":"crdApi"},{"location":"extensions/api/modules/main.k8sapi/#cronjobapi","text":"Re-exports: cronJobApi","title":"cronJobApi"},{"location":"extensions/api/modules/main.k8sapi/#daemonsetapi","text":"Re-exports: daemonSetApi","title":"daemonSetApi"},{"location":"extensions/api/modules/main.k8sapi/#deploymentapi_1","text":"Re-exports: deploymentApi","title":"deploymentApi"},{"location":"extensions/api/modules/main.k8sapi/#endpointapi","text":"Re-exports: endpointApi","title":"endpointApi"},{"location":"extensions/api/modules/main.k8sapi/#eventapi","text":"Re-exports: eventApi","title":"eventApi"},{"location":"extensions/api/modules/main.k8sapi/#forcluster","text":"Re-exports: forCluster","title":"forCluster"},{"location":"extensions/api/modules/main.k8sapi/#hpaapi","text":"Re-exports: hpaApi","title":"hpaApi"},{"location":"extensions/api/modules/main.k8sapi/#ingressapi_1","text":"Re-exports: ingressApi","title":"ingressApi"},{"location":"extensions/api/modules/main.k8sapi/#isallowedresource","text":"Re-exports: isAllowedResource","title":"isAllowedResource"},{"location":"extensions/api/modules/main.k8sapi/#jobapi","text":"Re-exports: jobApi","title":"jobApi"},{"location":"extensions/api/modules/main.k8sapi/#limitrangeapi","text":"Re-exports: limitRangeApi","title":"limitRangeApi"},{"location":"extensions/api/modules/main.k8sapi/#namespacesapi","text":"Re-exports: namespacesApi","title":"namespacesApi"},{"location":"extensions/api/modules/main.k8sapi/#networkpolicyapi","text":"Re-exports: networkPolicyApi","title":"networkPolicyApi"},{"location":"extensions/api/modules/main.k8sapi/#nodesapi_1","text":"Re-exports: nodesApi","title":"nodesApi"},{"location":"extensions/api/modules/main.k8sapi/#pdbapi","text":"Re-exports: pdbApi","title":"pdbApi"},{"location":"extensions/api/modules/main.k8sapi/#persistentvolumeapi","text":"Re-exports: persistentVolumeApi","title":"persistentVolumeApi"},{"location":"extensions/api/modules/main.k8sapi/#podsapi_1","text":"Re-exports: podsApi","title":"podsApi"},{"location":"extensions/api/modules/main.k8sapi/#pvcapi","text":"Re-exports: pvcApi","title":"pvcApi"},{"location":"extensions/api/modules/main.k8sapi/#replicasetapi","text":"Re-exports: replicaSetApi","title":"replicaSetApi"},{"location":"extensions/api/modules/main.k8sapi/#resourcequotaapi","text":"Re-exports: resourceQuotaApi","title":"resourceQuotaApi"},{"location":"extensions/api/modules/main.k8sapi/#roleapi","text":"Re-exports: roleApi","title":"roleApi"},{"location":"extensions/api/modules/main.k8sapi/#rolebindingapi","text":"Re-exports: roleBindingApi","title":"roleBindingApi"},{"location":"extensions/api/modules/main.k8sapi/#secretsapi","text":"Re-exports: secretsApi","title":"secretsApi"},{"location":"extensions/api/modules/main.k8sapi/#serviceaccountsapi","text":"Re-exports: serviceAccountsApi","title":"serviceAccountsApi"},{"location":"extensions/api/modules/main.k8sapi/#serviceapi","text":"Re-exports: serviceApi","title":"serviceApi"},{"location":"extensions/api/modules/main.k8sapi/#statefulsetapi","text":"Re-exports: statefulSetApi","title":"statefulSetApi"},{"location":"extensions/api/modules/main.k8sapi/#storageclassapi","text":"Re-exports: storageClassApi","title":"storageClassApi"},{"location":"extensions/api/modules/main/","text":"Namespace: Main # Table of contents # Namespaces # Catalog K8sApi Navigation Classes # Ipc LensExtension","title":"Namespace: Main"},{"location":"extensions/api/modules/main/#namespace-main","text":"","title":"Namespace: Main"},{"location":"extensions/api/modules/main/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/main/#namespaces","text":"Catalog K8sApi Navigation","title":"Namespaces"},{"location":"extensions/api/modules/main/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/api/modules/main.navigation/","text":"Namespace: Navigation # Main .Navigation Table of contents # Functions # navigate Functions # navigate # \u25b8 navigate ( url ): Promise Parameters # Name Type url string Returns # Promise ","title":"Namespace: Navigation"},{"location":"extensions/api/modules/main.navigation/#namespace-navigation","text":"Main .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/main.navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/main.navigation/#functions","text":"navigate","title":"Functions"},{"location":"extensions/api/modules/main.navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/main.navigation/#navigate","text":"\u25b8 navigate ( url ): Promise ","title":"navigate"},{"location":"extensions/api/modules/renderer.catalog/","text":"Namespace: Catalog # Renderer .Catalog Table of contents # Classes # CatalogEntityRegistry Variables # catalogCategories catalogEntities Variables # catalogCategories # \u2022 Const catalogCategories : CatalogCategoryRegistry catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/renderer.catalog/#namespace-catalog","text":"Renderer .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/renderer.catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer.catalog/#classes","text":"CatalogEntityRegistry","title":"Classes"},{"location":"extensions/api/modules/renderer.catalog/#variables","text":"catalogCategories catalogEntities","title":"Variables"},{"location":"extensions/api/modules/renderer.catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/renderer.catalog/#catalogcategories","text":"\u2022 Const catalogCategories : CatalogCategoryRegistry","title":"catalogCategories"},{"location":"extensions/api/modules/renderer.catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/renderer.component/","text":"Namespace: Component # Renderer .Component Table of contents # Enumerations # NotificationStatus TooltipPosition Classes # Badge BarChart Button Checkbox CommandOverlay ConfirmDialog Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MenuItem NamespaceSelect NamespaceSelectFilter Notifications NotificationsStore PageLayout PieChart PodDetailsList Radio RadioGroup SearchInput Select SettingLayout Slider Spinner StatusBrick Stepper SubTitle Tab Table TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep Interfaces # BadgeProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconDataFnArg IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification RadioGroupProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps WizardProps WizardStepProps Type aliases # IconData InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks TableSortParams Variables # InputValidators MenuContext Switcher cpuOptions kubeDetailsUrlParam kubeSelectedUrlParam logTabStore memoryOptions notificationsStore orderByUrlParam sortByUrlParam terminalStore Functions # DrawerItemLabels FormSwitch SubMenu TabLayout createTerminalTab getDetailsUrl hideDetails showDetails toggleDetails withTooltip Type aliases # IconData # \u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node InputProps # \u01ac InputProps : Omit & { autoSelectOnFocus? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; defaultValue? : string ; dirty? : boolean ; iconLeft? : IconData ; iconRight? : IconData ; maxRows? : number ; multiLine? : boolean ; showErrorsAsTooltip? : boolean | Omit < TooltipProps , \"targetId\" > ; showValidationLine? : boolean ; theme? : \"round-black\" | \"round\" ; trim? : boolean ; validators? : InputValidator | InputValidator [] ; value? : string ; onChange? : ( value : string , evt : ChangeEvent ) => void ; onSubmit? : ( value : string , evt : KeyboardEvent ) => void } MenuContextValue # \u01ac MenuContextValue : Menu NotificationId # \u01ac NotificationId : string | number NotificationMessage # \u01ac NotificationMessage : React.ReactNode | React.ReactNode [] | JsonApiErrorParsed RadioProps # \u01ac RadioProps : React.HTMLProps & { checked? : boolean ; disabled? : boolean ; label? : React.ReactNode | any ; name? : string ; value? : any ; onChange? : ( value : ChangeEvent ) => void } TableCellElem # \u01ac TableCellElem : React.ReactElement < TableCellProps > TableHeadElem # \u01ac TableHeadElem : React.ReactElement < TableHeadProps > TableOrderBy # \u01ac TableOrderBy : \"asc\" | \"desc\" | string TableRowElem # \u01ac TableRowElem : React.ReactElement < TableRowProps > TableSortBy # \u01ac TableSortBy : string TableSortCallback # \u01ac TableSortCallback : ( data : Item ) => string | number | ( string | number )[] Type parameters # Name Item Type declaration # \u25b8 ( data ): string | number | ( string | number )[] Parameters # Name Type data Item Returns # string | number | ( string | number )[] TableSortCallbacks # \u01ac TableSortCallbacks : Record > Type parameters # Name Item TableSortParams # \u01ac TableSortParams : Object Type declaration # Name Type orderBy TableOrderBy sortBy TableSortBy Variables # InputValidators # \u2022 InputValidators : Object Type declaration # Name Type accountId InputValidator isEmail InputValidator isExtensionNameInstall InputValidator isExtensionNameInstallRegex RegExp isNumber InputValidator isPath InputValidator isRequired InputValidator isUrl InputValidator maxLength InputValidator minLength InputValidator systemName InputValidator MenuContext # \u2022 Const MenuContext : Context < Menu > Switcher # \u2022 Const Switcher : ComponentType < Pick & StyledComponentProps < \"checked\" | \"track\" | \"root\" | \"thumb\" | \"focusVisible\" | \"switchBase\" >> cpuOptions # \u2022 Const cpuOptions : ChartOptions kubeDetailsUrlParam # \u2022 Const kubeDetailsUrlParam : PageParam Used to store object.selfLink to show more info about resource in the details panel. kubeSelectedUrlParam # \u2022 Const kubeSelectedUrlParam : PageParam 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). logTabStore # \u2022 Const logTabStore : LogTabStore memoryOptions # \u2022 Const memoryOptions : ChartOptions notificationsStore # \u2022 Const notificationsStore : NotificationsStore orderByUrlParam # \u2022 Const orderByUrlParam : PageParam sortByUrlParam # \u2022 Const sortByUrlParam : PageParam terminalStore # \u2022 Const terminalStore : TerminalStore deprecated use TerminalStore.getInstance() instead Functions # DrawerItemLabels # \u25b8 DrawerItemLabels ( props ): Element Parameters # Name Type props DrawerItemLabelsProps Returns # Element FormSwitch # \u25b8 FormSwitch ( props ): Element Parameters # Name Type props FormControlLabelProps Returns # Element SubMenu # \u25b8 SubMenu ( props ): Element Parameters # Name Type props Partial < MenuProps > Returns # Element TabLayout # \u25b8 Const TabLayout ( __namedParameters ): Element Parameters # Name Type __namedParameters TabLayoutProps Returns # Element createTerminalTab # \u25b8 createTerminalTab ( tabParams? ): Required Parameters # Name Type tabParams DockTabCreateSpecific Returns # Required getDetailsUrl # \u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Parameters # Name Type Default value selfLink string undefined resetSelected boolean false mergeGlobals boolean true Returns # string hideDetails # \u25b8 hideDetails (): void Returns # void showDetails # \u25b8 showDetails ( selfLink? , resetSelected? ): void Parameters # Name Type Default value selfLink string \"\" resetSelected boolean true Returns # void toggleDetails # \u25b8 toggleDetails ( selfLink , resetSelected? ): void Parameters # Name Type Default value selfLink string undefined resetSelected boolean true Returns # void withTooltip # \u25b8 withTooltip ( Target ): T Type parameters # Name Type T T : ComponentType Parameters # Name Type Target T Returns # T","title":"Namespace: Component"},{"location":"extensions/api/modules/renderer.component/#namespace-component","text":"Renderer .Component","title":"Namespace: Component"},{"location":"extensions/api/modules/renderer.component/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer.component/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/renderer.component/#classes","text":"Badge BarChart Button Checkbox CommandOverlay ConfirmDialog Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MenuItem NamespaceSelect NamespaceSelectFilter Notifications NotificationsStore PageLayout PieChart PodDetailsList Radio RadioGroup SearchInput Select SettingLayout Slider Spinner StatusBrick Stepper SubTitle Tab Table TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep","title":"Classes"},{"location":"extensions/api/modules/renderer.component/#interfaces","text":"BadgeProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconDataFnArg IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification RadioGroupProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps WizardProps WizardStepProps","title":"Interfaces"},{"location":"extensions/api/modules/renderer.component/#type-aliases","text":"IconData InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks TableSortParams","title":"Type aliases"},{"location":"extensions/api/modules/renderer.component/#variables","text":"InputValidators MenuContext Switcher cpuOptions kubeDetailsUrlParam kubeSelectedUrlParam logTabStore memoryOptions notificationsStore orderByUrlParam sortByUrlParam terminalStore","title":"Variables"},{"location":"extensions/api/modules/renderer.component/#functions","text":"DrawerItemLabels FormSwitch SubMenu TabLayout createTerminalTab getDetailsUrl hideDetails showDetails toggleDetails withTooltip","title":"Functions"},{"location":"extensions/api/modules/renderer.component/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/renderer.component/#icondata","text":"\u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node","title":"IconData"},{"location":"extensions/api/modules/renderer.component/#inputprops","text":"\u01ac InputProps : Omit & { autoSelectOnFocus? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; defaultValue? : string ; dirty? : boolean ; iconLeft? : IconData ; iconRight? : IconData ; maxRows? : number ; multiLine? : boolean ; showErrorsAsTooltip? : boolean | Omit < TooltipProps , \"targetId\" > ; showValidationLine? : boolean ; theme? : \"round-black\" | \"round\" ; trim? : boolean ; validators? : InputValidator | InputValidator [] ; value? : string ; onChange? : ( value : string , evt : ChangeEvent ) => void ; onSubmit? : ( value : string , evt : KeyboardEvent ) => void }","title":"InputProps"},{"location":"extensions/api/modules/renderer.component/#menucontextvalue","text":"\u01ac MenuContextValue : Menu","title":"MenuContextValue"},{"location":"extensions/api/modules/renderer.component/#notificationid","text":"\u01ac NotificationId : string | number","title":"NotificationId"},{"location":"extensions/api/modules/renderer.component/#notificationmessage","text":"\u01ac NotificationMessage : React.ReactNode | React.ReactNode [] | JsonApiErrorParsed","title":"NotificationMessage"},{"location":"extensions/api/modules/renderer.component/#radioprops","text":"\u01ac RadioProps : React.HTMLProps & { checked? : boolean ; disabled? : boolean ; label? : React.ReactNode | any ; name? : string ; value? : any ; onChange? : ( value : ChangeEvent ) => void }","title":"RadioProps"},{"location":"extensions/api/modules/renderer.component/#tablecellelem","text":"\u01ac TableCellElem : React.ReactElement < TableCellProps >","title":"TableCellElem"},{"location":"extensions/api/modules/renderer.component/#tableheadelem","text":"\u01ac TableHeadElem : React.ReactElement < TableHeadProps >","title":"TableHeadElem"},{"location":"extensions/api/modules/renderer.component/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\" | string","title":"TableOrderBy"},{"location":"extensions/api/modules/renderer.component/#tablerowelem","text":"\u01ac TableRowElem : React.ReactElement < TableRowProps >","title":"TableRowElem"},{"location":"extensions/api/modules/renderer.component/#tablesortby","text":"\u01ac TableSortBy : string","title":"TableSortBy"},{"location":"extensions/api/modules/renderer.component/#tablesortcallback","text":"\u01ac TableSortCallback : ( data : Item ) => string | number | ( string | number )[]","title":"TableSortCallback"},{"location":"extensions/api/modules/renderer.component/#tablesortcallbacks","text":"\u01ac TableSortCallbacks : Record >","title":"TableSortCallbacks"},{"location":"extensions/api/modules/renderer.component/#tablesortparams","text":"\u01ac TableSortParams : Object","title":"TableSortParams"},{"location":"extensions/api/modules/renderer.component/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/renderer.component/#inputvalidators","text":"\u2022 InputValidators : Object","title":"InputValidators"},{"location":"extensions/api/modules/renderer.component/#menucontext","text":"\u2022 Const MenuContext : Context < Menu >","title":"MenuContext"},{"location":"extensions/api/modules/renderer.component/#switcher","text":"\u2022 Const Switcher : ComponentType < Pick & StyledComponentProps < \"checked\" | \"track\" | \"root\" | \"thumb\" | \"focusVisible\" | \"switchBase\" >>","title":"Switcher"},{"location":"extensions/api/modules/renderer.component/#cpuoptions","text":"\u2022 Const cpuOptions : ChartOptions","title":"cpuOptions"},{"location":"extensions/api/modules/renderer.component/#kubedetailsurlparam","text":"\u2022 Const kubeDetailsUrlParam : PageParam Used to store object.selfLink to show more info about resource in the details panel.","title":"kubeDetailsUrlParam"},{"location":"extensions/api/modules/renderer.component/#kubeselectedurlparam","text":"\u2022 Const kubeSelectedUrlParam : PageParam 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).","title":"kubeSelectedUrlParam"},{"location":"extensions/api/modules/renderer.component/#logtabstore","text":"\u2022 Const logTabStore : LogTabStore","title":"logTabStore"},{"location":"extensions/api/modules/renderer.component/#memoryoptions","text":"\u2022 Const memoryOptions : ChartOptions","title":"memoryOptions"},{"location":"extensions/api/modules/renderer.component/#notificationsstore","text":"\u2022 Const notificationsStore : NotificationsStore","title":"notificationsStore"},{"location":"extensions/api/modules/renderer.component/#orderbyurlparam","text":"\u2022 Const orderByUrlParam : PageParam ","title":"orderByUrlParam"},{"location":"extensions/api/modules/renderer.component/#sortbyurlparam","text":"\u2022 Const sortByUrlParam : PageParam ","title":"sortByUrlParam"},{"location":"extensions/api/modules/renderer.component/#terminalstore","text":"\u2022 Const terminalStore : TerminalStore deprecated use TerminalStore.getInstance() instead","title":"terminalStore"},{"location":"extensions/api/modules/renderer.component/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/renderer.component/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props ): Element","title":"DrawerItemLabels"},{"location":"extensions/api/modules/renderer.component/#formswitch","text":"\u25b8 FormSwitch ( props ): Element","title":"FormSwitch"},{"location":"extensions/api/modules/renderer.component/#submenu","text":"\u25b8 SubMenu ( props ): Element","title":"SubMenu"},{"location":"extensions/api/modules/renderer.component/#tablayout","text":"\u25b8 Const TabLayout ( __namedParameters ): Element","title":"TabLayout"},{"location":"extensions/api/modules/renderer.component/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams? ): Required ","title":"createTerminalTab"},{"location":"extensions/api/modules/renderer.component/#getdetailsurl","text":"\u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string","title":"getDetailsUrl"},{"location":"extensions/api/modules/renderer.component/#hidedetails","text":"\u25b8 hideDetails (): void","title":"hideDetails"},{"location":"extensions/api/modules/renderer.component/#showdetails","text":"\u25b8 showDetails ( selfLink? , resetSelected? ): void","title":"showDetails"},{"location":"extensions/api/modules/renderer.component/#toggledetails","text":"\u25b8 toggleDetails ( selfLink , resetSelected? ): void","title":"toggleDetails"},{"location":"extensions/api/modules/renderer.component/#withtooltip","text":"\u25b8 withTooltip ( Target ): T","title":"withTooltip"},{"location":"extensions/api/modules/renderer.k8sapi/","text":"Namespace: K8sApi # Renderer .K8sApi Table of contents # Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore LimitRange LimitRangesStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore ResourceStack Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore Interfaces # IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Type aliases # KubeObjectStatus Variables # apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi Functions # forCluster isAllowedResource Type aliases # KubeObjectStatus # \u01ac KubeObjectStatus : Object Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Type declaration # Name Type level KubeObjectStatusLevel text string timestamp? string Variables # apiManager # \u2022 Const apiManager : ApiManager clusterRoleApi # \u2022 Let clusterRoleApi : KubeApi < ClusterRole > Only available within kubernetes cluster pages clusterRoleBindingApi # \u2022 Let clusterRoleBindingApi : KubeApi < ClusterRoleBinding > Only available within kubernetes cluster pages configMapApi # \u2022 Let configMapApi : KubeApi < ConfigMap > Only available within kubernetes cluster pages crdApi # \u2022 Let crdApi : KubeApi < CustomResourceDefinition > Only available within kubernetes cluster pages cronJobApi # \u2022 Let cronJobApi : CronJobApi Only available within kubernetes cluster pages daemonSetApi # \u2022 Let daemonSetApi : DaemonSetApi Only available within kubernetes cluster pages deploymentApi # \u2022 Let deploymentApi : DeploymentApi endpointApi # \u2022 Let endpointApi : KubeApi < Endpoint > eventApi # \u2022 Let eventApi : KubeApi < KubeEvent > hpaApi # \u2022 Let hpaApi : KubeApi < HorizontalPodAutoscaler > ingressApi # \u2022 Let ingressApi : IngressApi jobApi # \u2022 Let jobApi : JobApi limitRangeApi # \u2022 Let limitRangeApi : KubeApi < LimitRange > namespacesApi # \u2022 Let namespacesApi : NamespaceApi networkPolicyApi # \u2022 Let networkPolicyApi : KubeApi < NetworkPolicy > nodesApi # \u2022 Let nodesApi : NodesApi pdbApi # \u2022 Let pdbApi : KubeApi < PodDisruptionBudget > persistentVolumeApi # \u2022 Let persistentVolumeApi : KubeApi < PersistentVolume > podsApi # \u2022 Let podsApi : PodsApi pvcApi # \u2022 Let pvcApi : PersistentVolumeClaimsApi replicaSetApi # \u2022 Let replicaSetApi : ReplicaSetApi resourceQuotaApi # \u2022 Let resourceQuotaApi : KubeApi < ResourceQuota > roleApi # \u2022 Let roleApi : KubeApi < Role > roleBindingApi # \u2022 Let roleBindingApi : KubeApi < RoleBinding > secretsApi # \u2022 Let secretsApi : KubeApi < Secret > serviceAccountsApi # \u2022 Let serviceAccountsApi : KubeApi < ServiceAccount > serviceApi # \u2022 Let serviceApi : KubeApi < Service > statefulSetApi # \u2022 Let statefulSetApi : StatefulSetApi storageClassApi # \u2022 Let storageClassApi : KubeApi < StorageClass > Functions # forCluster # \u25b8 forCluster ( cluster , kubeClass ): KubeApi Type parameters # Name Type T T : KubeObject Parameters # Name Type cluster IKubeApiCluster kubeClass KubeObjectConstructor Returns # KubeApi isAllowedResource # \u25b8 isAllowedResource ( resource ): boolean Parameters # Name Type resource KubeResource | KubeResource [] Returns # boolean","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/renderer.k8sapi/#namespace-k8sapi","text":"Renderer .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/renderer.k8sapi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer.k8sapi/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/renderer.k8sapi/#classes","text":"CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore LimitRange LimitRangesStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore ResourceStack Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/renderer.k8sapi/#interfaces","text":"IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef","title":"Interfaces"},{"location":"extensions/api/modules/renderer.k8sapi/#type-aliases","text":"KubeObjectStatus","title":"Type aliases"},{"location":"extensions/api/modules/renderer.k8sapi/#variables","text":"apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"Variables"},{"location":"extensions/api/modules/renderer.k8sapi/#functions","text":"forCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/renderer.k8sapi/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/renderer.k8sapi/#kubeobjectstatus","text":"\u01ac KubeObjectStatus : Object Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"KubeObjectStatus"},{"location":"extensions/api/modules/renderer.k8sapi/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/renderer.k8sapi/#apimanager","text":"\u2022 Const apiManager : ApiManager","title":"apiManager"},{"location":"extensions/api/modules/renderer.k8sapi/#clusterroleapi","text":"\u2022 Let clusterRoleApi : KubeApi < ClusterRole > Only available within kubernetes cluster pages","title":"clusterRoleApi"},{"location":"extensions/api/modules/renderer.k8sapi/#clusterrolebindingapi","text":"\u2022 Let clusterRoleBindingApi : KubeApi < ClusterRoleBinding > Only available within kubernetes cluster pages","title":"clusterRoleBindingApi"},{"location":"extensions/api/modules/renderer.k8sapi/#configmapapi","text":"\u2022 Let configMapApi : KubeApi < ConfigMap > Only available within kubernetes cluster pages","title":"configMapApi"},{"location":"extensions/api/modules/renderer.k8sapi/#crdapi","text":"\u2022 Let crdApi : KubeApi < CustomResourceDefinition > Only available within kubernetes cluster pages","title":"crdApi"},{"location":"extensions/api/modules/renderer.k8sapi/#cronjobapi","text":"\u2022 Let cronJobApi : CronJobApi Only available within kubernetes cluster pages","title":"cronJobApi"},{"location":"extensions/api/modules/renderer.k8sapi/#daemonsetapi","text":"\u2022 Let daemonSetApi : DaemonSetApi Only available within kubernetes cluster pages","title":"daemonSetApi"},{"location":"extensions/api/modules/renderer.k8sapi/#deploymentapi","text":"\u2022 Let deploymentApi : DeploymentApi","title":"deploymentApi"},{"location":"extensions/api/modules/renderer.k8sapi/#endpointapi","text":"\u2022 Let endpointApi : KubeApi < Endpoint >","title":"endpointApi"},{"location":"extensions/api/modules/renderer.k8sapi/#eventapi","text":"\u2022 Let eventApi : KubeApi < KubeEvent >","title":"eventApi"},{"location":"extensions/api/modules/renderer.k8sapi/#hpaapi","text":"\u2022 Let hpaApi : KubeApi < HorizontalPodAutoscaler >","title":"hpaApi"},{"location":"extensions/api/modules/renderer.k8sapi/#ingressapi","text":"\u2022 Let ingressApi : IngressApi","title":"ingressApi"},{"location":"extensions/api/modules/renderer.k8sapi/#jobapi","text":"\u2022 Let jobApi : JobApi","title":"jobApi"},{"location":"extensions/api/modules/renderer.k8sapi/#limitrangeapi","text":"\u2022 Let limitRangeApi : KubeApi < LimitRange >","title":"limitRangeApi"},{"location":"extensions/api/modules/renderer.k8sapi/#namespacesapi","text":"\u2022 Let namespacesApi : NamespaceApi","title":"namespacesApi"},{"location":"extensions/api/modules/renderer.k8sapi/#networkpolicyapi","text":"\u2022 Let networkPolicyApi : KubeApi < NetworkPolicy >","title":"networkPolicyApi"},{"location":"extensions/api/modules/renderer.k8sapi/#nodesapi","text":"\u2022 Let nodesApi : NodesApi","title":"nodesApi"},{"location":"extensions/api/modules/renderer.k8sapi/#pdbapi","text":"\u2022 Let pdbApi : KubeApi < PodDisruptionBudget >","title":"pdbApi"},{"location":"extensions/api/modules/renderer.k8sapi/#persistentvolumeapi","text":"\u2022 Let persistentVolumeApi : KubeApi < PersistentVolume >","title":"persistentVolumeApi"},{"location":"extensions/api/modules/renderer.k8sapi/#podsapi","text":"\u2022 Let podsApi : PodsApi","title":"podsApi"},{"location":"extensions/api/modules/renderer.k8sapi/#pvcapi","text":"\u2022 Let pvcApi : PersistentVolumeClaimsApi","title":"pvcApi"},{"location":"extensions/api/modules/renderer.k8sapi/#replicasetapi","text":"\u2022 Let replicaSetApi : ReplicaSetApi","title":"replicaSetApi"},{"location":"extensions/api/modules/renderer.k8sapi/#resourcequotaapi","text":"\u2022 Let resourceQuotaApi : KubeApi < ResourceQuota >","title":"resourceQuotaApi"},{"location":"extensions/api/modules/renderer.k8sapi/#roleapi","text":"\u2022 Let roleApi : KubeApi < Role >","title":"roleApi"},{"location":"extensions/api/modules/renderer.k8sapi/#rolebindingapi","text":"\u2022 Let roleBindingApi : KubeApi < RoleBinding >","title":"roleBindingApi"},{"location":"extensions/api/modules/renderer.k8sapi/#secretsapi","text":"\u2022 Let secretsApi : KubeApi < Secret >","title":"secretsApi"},{"location":"extensions/api/modules/renderer.k8sapi/#serviceaccountsapi","text":"\u2022 Let serviceAccountsApi : KubeApi < ServiceAccount >","title":"serviceAccountsApi"},{"location":"extensions/api/modules/renderer.k8sapi/#serviceapi","text":"\u2022 Let serviceApi : KubeApi < Service >","title":"serviceApi"},{"location":"extensions/api/modules/renderer.k8sapi/#statefulsetapi","text":"\u2022 Let statefulSetApi : StatefulSetApi","title":"statefulSetApi"},{"location":"extensions/api/modules/renderer.k8sapi/#storageclassapi","text":"\u2022 Let storageClassApi : KubeApi < StorageClass >","title":"storageClassApi"},{"location":"extensions/api/modules/renderer.k8sapi/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/renderer.k8sapi/#forcluster","text":"\u25b8 forCluster ( cluster , kubeClass ): KubeApi ","title":"forCluster"},{"location":"extensions/api/modules/renderer.k8sapi/#isallowedresource","text":"\u25b8 isAllowedResource ( resource ): boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/renderer/","text":"Namespace: Renderer # Table of contents # Namespaces # Catalog Component K8sApi Navigation Theme Classes # Ipc LensExtension","title":"Namespace: Renderer"},{"location":"extensions/api/modules/renderer/#namespace-renderer","text":"","title":"Namespace: Renderer"},{"location":"extensions/api/modules/renderer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer/#namespaces","text":"Catalog Component K8sApi Navigation Theme","title":"Namespaces"},{"location":"extensions/api/modules/renderer/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/api/modules/renderer.navigation/","text":"Namespace: Navigation # Renderer .Navigation Table of contents # References # getDetailsUrl hideDetails showDetails Classes # PageParam Interfaces # PageParamInit URLParams Functions # createPageParam isActiveRoute navigate References # getDetailsUrl # Re-exports: getDetailsUrl hideDetails # Re-exports: hideDetails showDetails # Re-exports: showDetails Functions # createPageParam # \u25b8 createPageParam ( init ): PageParam Type parameters # Name V Parameters # Name Type init PageParamInit Returns # PageParam isActiveRoute # \u25b8 isActiveRoute ( route ): boolean Parameters # Name Type route string | string [] | RouteProps Returns # boolean navigate # \u25b8 navigate ( location ): void Parameters # Name Type location LocationDescriptor Returns # void","title":"Namespace: Navigation"},{"location":"extensions/api/modules/renderer.navigation/#namespace-navigation","text":"Renderer .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/renderer.navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer.navigation/#references","text":"getDetailsUrl hideDetails showDetails","title":"References"},{"location":"extensions/api/modules/renderer.navigation/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/renderer.navigation/#interfaces","text":"PageParamInit URLParams","title":"Interfaces"},{"location":"extensions/api/modules/renderer.navigation/#functions","text":"createPageParam isActiveRoute navigate","title":"Functions"},{"location":"extensions/api/modules/renderer.navigation/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/renderer.navigation/#getdetailsurl","text":"Re-exports: getDetailsUrl","title":"getDetailsUrl"},{"location":"extensions/api/modules/renderer.navigation/#hidedetails","text":"Re-exports: hideDetails","title":"hideDetails"},{"location":"extensions/api/modules/renderer.navigation/#showdetails","text":"Re-exports: showDetails","title":"showDetails"},{"location":"extensions/api/modules/renderer.navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/renderer.navigation/#createpageparam","text":"\u25b8 createPageParam ( init ): PageParam ","title":"createPageParam"},{"location":"extensions/api/modules/renderer.navigation/#isactiveroute","text":"\u25b8 isActiveRoute ( route ): boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/renderer.navigation/#navigate","text":"\u25b8 navigate ( location ): void","title":"navigate"},{"location":"extensions/api/modules/renderer.theme/","text":"Namespace: Theme # Renderer .Theme Table of contents # Functions # getActiveTheme Functions # getActiveTheme # \u25b8 getActiveTheme (): Theme Returns # Theme","title":"Namespace: Theme"},{"location":"extensions/api/modules/renderer.theme/#namespace-theme","text":"Renderer .Theme","title":"Namespace: Theme"},{"location":"extensions/api/modules/renderer.theme/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/renderer.theme/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/renderer.theme/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/renderer.theme/#getactivetheme","text":"\u25b8 getActiveTheme (): Theme","title":"getActiveTheme"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities. Main Extension # The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { 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 { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . 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 { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { 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 { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < 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 { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { 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 { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Top Bar Items # This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] } Kubernetes Workloads Overview Items # This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { 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 { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#main-extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#app-menus","text":"This extension can register custom app menus that will be displayed on OS native menus. Example: import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } } ] }","title":"App Menus"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#global-pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","text":"This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] }","title":"Top Bar Items"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","text":"This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] }","title":"Kubernetes Workloads Overview Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application. Layout # For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); } Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#styling-an-extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#layout-variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#theme-variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); }","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#injected-styles","text":"Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#css-in-js","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first. Extension Manifest # Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Extension Entry Files # Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#extension-entry-files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # This is a general overview to how the development of an extension will 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 \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system. Recommended: # All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is 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.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"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.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is 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.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more. Extension Capabilities # In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page. Guides and Samples # Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading. First Extension # In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. You will see the \"Hello World\" page in the left-side cluster menu. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#first-extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. You will see the \"Hello World\" page in the left-side cluster menu.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Samples # Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Overview"},{"location":"extensions/guides/#extension-guides","text":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/catalog/","text":"Catalog (WIP) # CatalogCategoryRegistry # CatalogEntityRegistry #","title":"Catalog"},{"location":"extensions/guides/catalog/#catalog-wip","text":"","title":"Catalog (WIP)"},{"location":"extensions/guides/catalog/#catalogcategoryregistry","text":"","title":"CatalogCategoryRegistry"},{"location":"extensions/guides/catalog/#catalogentityregistry","text":"","title":"CatalogEntityRegistry"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/generator/","text":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens\". To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the latest Lens contribution guidelines here . The Generator source code is hosted at GitHub .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens\". To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the latest Lens contribution guidelines here . The Generator source code is hosted at GitHub .","title":"Next Steps"},{"location":"extensions/guides/ipc/","text":"Inter Process Communication # A Lens Extension can utilize IPC to send information between the renderer and main processes. This is useful when wanting to communicate directly within your extension. For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog , this would be a good way to send that information along. IPC channels are sectioned off per extension. Meaning that each extension can only communicate with itself. Types of Communication # There are two flavours of communication that are provided: Event based (IPC) Request based (RPC) Event Based or IPC # This is the same as an Event Emitter but is not limited to just one Javascript process. This is a good option when you need to report that something has happened but you don't need a response. This is a fully two-way form of communication. Both main and renderer can do this sort of IPC. Request Based or RPC # This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). With this sort of communication the caller needs to wait for the result from the other side. This is accomplished by await -ing the returned Promise . This is a unidirectional form of communication. Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request. Registering IPC Handlers and Listeners # The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } This file shows that you need to create an instance of the store to be able to use IPC. Lens will automatically clean up that store and all the handlers on deactivation and uninstall. helpers/main.ts : import { Main } from \"@k8slens/extensions\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } In other files, it is not necessary to pass around any instances. You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension. renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} It is necessary to create child classes of these abstract class 's in your extension before you can use them. As this example shows: the channel names must be the same. It should also be noted that \"listeners\" and \"handlers\" are specific to either renderer or main . There is no behind the scenes transfer of these functions. To register a \"handler\" call IpcMain.getInstance().handle(...) . The cleanup of these handlers is handled by Lens itself. The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer , or more specifically, a () => void . This can be optionally called to remove the listener early. Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main . Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified. Allowed Values # This IPC mechanism utilizes the Structured Clone Algorithm for serialization. This means that more types than what are JSON serializable can be used, but not all the information will be passed through. Using Request Based Communication # If you are meaning to do a request based call from renderer , you should do const res = await IpcRenderer.getInstance().invoke(, ...)); instead.","title":"IPC"},{"location":"extensions/guides/ipc/#inter-process-communication","text":"A Lens Extension can utilize IPC to send information between the renderer and main processes. This is useful when wanting to communicate directly within your extension. For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog , this would be a good way to send that information along. IPC channels are sectioned off per extension. Meaning that each extension can only communicate with itself.","title":"Inter Process Communication"},{"location":"extensions/guides/ipc/#types-of-communication","text":"There are two flavours of communication that are provided: Event based (IPC) Request based (RPC)","title":"Types of Communication"},{"location":"extensions/guides/ipc/#event-based-or-ipc","text":"This is the same as an Event Emitter but is not limited to just one Javascript process. This is a good option when you need to report that something has happened but you don't need a response. This is a fully two-way form of communication. Both main and renderer can do this sort of IPC.","title":"Event Based or IPC"},{"location":"extensions/guides/ipc/#request-based-or-rpc","text":"This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). With this sort of communication the caller needs to wait for the result from the other side. This is accomplished by await -ing the returned Promise . This is a unidirectional form of communication. Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request.","title":"Request Based or RPC"},{"location":"extensions/guides/ipc/#registering-ipc-handlers-and-listeners","text":"The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } This file shows that you need to create an instance of the store to be able to use IPC. Lens will automatically clean up that store and all the handlers on deactivation and uninstall. helpers/main.ts : import { Main } from \"@k8slens/extensions\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } In other files, it is not necessary to pass around any instances. You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension. renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} It is necessary to create child classes of these abstract class 's in your extension before you can use them. As this example shows: the channel names must be the same. It should also be noted that \"listeners\" and \"handlers\" are specific to either renderer or main . There is no behind the scenes transfer of these functions. To register a \"handler\" call IpcMain.getInstance().handle(...) . The cleanup of these handlers is handled by Lens itself. The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer , or more specifically, a () => void . This can be optionally called to remove the listener early. Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main . Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified.","title":"Registering IPC Handlers and Listeners"},{"location":"extensions/guides/ipc/#allowed-values","text":"This IPC mechanism utilizes the Structured Clone Algorithm for serialization. This means that more types than what are JSON serializable can be used, but not all the information will be passed through.","title":"Allowed Values"},{"location":"extensions/guides/ipc/#using-request-based-communication","text":"If you are meaning to do a request based call from renderer , you should do const res = await IpcRenderer.getInstance().invoke(, ...)); instead.","title":"Using Request Based Communication"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends Renderer . LensExtension { } 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. import { Renderer } from \"@k8slens/extensions\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { 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 Renderer . LensExtension { ... 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 Renderer.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 Renderer.K8sApi.KubeObject , CertificatesApi derived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: import { Renderer } from \"@k8slens/extensions\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends 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 KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. 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 { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. Renderer.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: import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" 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 ]} /> < /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 Renderer . LensExtension { //... 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 Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < 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 ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } } Summary # Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends Renderer . LensExtension { } 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. import { Renderer } from \"@k8slens/extensions\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { 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 Renderer . LensExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Renderer.Component.KubeObjectListLayout component to list Certificate CRD objects.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from Renderer.K8sApi.KubeObject , CertificatesApi derived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: import { Renderer } from \"@k8slens/extensions\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends 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 KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. Renderer.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: import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" 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 ]} /> < /TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends Renderer . LensExtension { //... 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 Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < 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 ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and protocol handlers , and run custom code in Lens's main process. It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities. Main.LensExtension Class # onActivate() and onDeactivate() Methods # To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( 'custom main process extension code started' ); } onDeactivate () { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. 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 { Main } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends Main . LensExtension { 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 Renderer.LensExtension class and can be defined in the process of extending it. The following example demonstrates how an application menu can be used to navigate to such a page: import { Main } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ) } ] } When the menu item is clicked the navigate() method looks for and displays a global page with id \"myGlobalPage\" . This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension ). addCatalogSource() and removeCatalogSource() Methods # The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). See the Catalog documentation for full details about the catalog.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and protocol handlers , and run custom code in Lens's main process. It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#mainlensextension-class","text":"","title":"Main.LensExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","text":"To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( 'custom main process extension code started' ); } onDeactivate () { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. For more details on accessing Lens state data, please see the Stores guide.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#appmenus","text":"The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu. import { Main } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends Main . LensExtension { 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 Renderer.LensExtension class and can be defined in the process of extending it. The following example demonstrates how an application menu can be used to navigate to such a page: import { Main } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ) } ] } When the menu item is clicked the navigate() method looks for and displays a global page with id \"myGlobalPage\" . This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension ).","title":"appMenus"},{"location":"extensions/guides/main-extension/#addcatalogsource-and-removecatalogsource-methods","text":"The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). See the Catalog documentation for full details about the catalog.","title":"addCatalogSource() and removeCatalogSource() Methods"},{"location":"extensions/guides/protocol-handlers/","text":"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 { Main , Common } from \"@k8slens/extensions\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { 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: 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: \"/\" \"/display\" \"/display/:type\" \"/show/:id\" 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.","title":"Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#lens-protocol-handlers","text":"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.","title":"Lens Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#registering-a-protocol-handler","text":"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 { Main , Common } from \"@k8slens/extensions\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { 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/","title":"Registering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","text":"All that is needed to deregister a handler is to remove it from the array of handlers.","title":"Deregistering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#routing-algorithm","text":"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: 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: \"/\" \"/display\" \"/display/:type\" \"/show/:id\" 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.","title":"Routing Algorithm"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension (WIP) # 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, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process. The custom Lens UI elements that you can add include: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers Renderer.LensExtension Class # onActivate() and onDeactivate() Methods # To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( 'custom renderer process extension code started' ); } onDeactivate () { console . log ( 'custom renderer process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Info Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) For the extension you want to disable, open the context menu (click on the three vertical dots) and choose Disable . The example above logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with ClusterStore.getInstance() . Add a cluster page definition to a Renderer.LensExtension subclass with the following example: import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. ExamplePage in the example above can be defined in page.tsx : import { Renderer } 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, below Lens's standard cluster menus like Workloads , Custom Resources , etc. By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition: import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { 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 { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension } > { 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 Renderer.Component.Icon , introduced in ExampleIcon , which you can use to access any of the icons available at Material Design . The properties that Renderer.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 { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { 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 could 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 (or catalog entities), including customized data and functionality unique to your extension. Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity). The following example defines a Renderer.LensExtension subclass with a single global page definition: import { Renderer } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. HelpPage in the example above can be defined in page.tsx : import { Renderer } 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 are typically 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 Welcome Page, see welcomeMenus . welcomeMenus # 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 { Renderer } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @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 { Renderer } from \"@k8slens/extensions\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox , }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false }}); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < 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 Renderer.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 makeObservable 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 . topBarItems # 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 { Renderer } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { components : { Item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ) }, }, ]; } The properties of the statusBarItems array objects are defined as follows: Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide . onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages. kubeObjectMenuItems # An extension can add custom menu items ( kubeObjectMenuItems ) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard: They also appear on the title bar of the details page for specific resources: The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action: import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < 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 { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon , }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } NamespaceMenuItem returns a Renderer.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 Renderer.K8sApi.Namespace . Renderer.K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName() . Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details ( kubeObjectDetailItems ) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here: The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < 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 { Renderer } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi , }, Component : { DrawerTitle , }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace >> { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> , it can access the current namespace object (type 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 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 podsApi.list() method. The podsApi is automatically configured for the active cluster. Note that 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 Renderer.Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table , }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface Props { pods? : Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ) }; render () { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow ) } < /Table> < /div> ); } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: Obtain the name, age, and status for each pod using the Renderer.K8sApi.Pod methods. Construct the table using the Renderer.Component.Table and related elements. For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. The table is constructed using the Renderer.Component.Table and related elements. See Component documentation for further details. kubeObjectStatusTexts # kubeWorkloadsOverviewItems # entitySettings # catalogEntityDetailItems # commandPaletteCommands # protocolHandlers # See the Protocol Handlers Guide","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension-wip","text":"The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process. The custom Lens UI elements that you can add include: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers","title":"Renderer Extension (WIP)"},{"location":"extensions/guides/renderer-extension/#rendererlensextension-class","text":"","title":"Renderer.LensExtension Class"},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","text":"To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( 'custom renderer process extension code started' ); } onDeactivate () { console . log ( 'custom renderer process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Info Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) For the extension you want to disable, open the context menu (click on the three vertical dots) and choose Disable . The example above logs messages when the extension is enabled and disabled.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with ClusterStore.getInstance() . Add a cluster page definition to a Renderer.LensExtension subclass with the following example: import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. ExamplePage in the example above can be defined in page.tsx : import { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data. The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus , covered in the next section, to add cluster pages to the Lens UI.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"clusterPageMenus allows you to add cluster page menu items to the secondary left nav, below Lens's standard cluster menus like Workloads , Custom Resources , etc. By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition: import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { 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 { Renderer } from \"@k8slens/extensions\" ; import React from \"react\" type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension } > { 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 Renderer.Component.Icon , introduced in ExampleIcon , which you can use to access any of the icons available at Material Design . The properties that Renderer.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 { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { 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 could look like, including how the menu item will appear in the secondary left nav:","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters (or catalog entities), including customized data and functionality unique to your extension. Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity). The following example defines a Renderer.LensExtension subclass with a single global page definition: import { Renderer } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. HelpPage in the example above can be defined in page.tsx : import { Renderer } 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 are typically 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 Welcome Page, see welcomeMenus .","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#welcomemenus","text":"","title":"welcomeMenus"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options. The following example demonstrates adding a custom preference: import { Renderer } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @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 { Renderer } from \"@k8slens/extensions\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox , }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false }}); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < 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 Renderer.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 makeObservable and observer from the mobx and mobx-react packages. mobx simplifies state management. Without it, this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use. Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore .","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#topbaritems","text":"","title":"topBarItems"},{"location":"extensions/guides/renderer-extension/#statusbaritems","text":"The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages. The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { Renderer } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { components : { Item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ) }, }, ]; } The properties of the statusBarItems array objects are defined as follows: Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide . onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items ( kubeObjectMenuItems ) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard: They also appear on the title bar of the details page for specific resources: The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action: import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < 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 { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon , }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } NamespaceMenuItem returns a Renderer.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 Renderer.K8sApi.Namespace . Renderer.K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName() . Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","text":"An extension can add custom details ( kubeObjectDetailItems ) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here: The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < 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 { Renderer } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi , }, Component : { DrawerTitle , }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace >> { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> , it can access the current namespace object (type 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 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 podsApi.list() method. The podsApi is automatically configured for the active cluster. Note that 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 Renderer.Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table , }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface Props { pods? : Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ) }; render () { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow ) } < /Table> < /div> ); } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: Obtain the name, age, and status for each pod using the Renderer.K8sApi.Pod methods. Construct the table using the Renderer.Component.Table and related elements. For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. The table is constructed using the Renderer.Component.Table and related elements. See Component documentation for further details.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectstatustexts","text":"","title":"kubeObjectStatusTexts"},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","text":"","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/guides/renderer-extension/#entitysettings","text":"","title":"entitySettings"},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","text":"","title":"catalogEntityDetailItems"},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","text":"","title":"commandPaletteCommands"},{"location":"extensions/guides/renderer-extension/#protocolhandlers","text":"See the Protocol Handlers Guide","title":"protocolHandlers"},{"location":"extensions/guides/resource-stack/","text":"Resource Stack (Cluster Feature) # A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the life cycle of the resource stack. It could be applied automatically to a cluster by the extension, or the end-user could be required to install it. The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable 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 resource stack in this example consists of a single kubernetes resource: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx It is simply a pod named example-pod , running nginx. Assume this content is in the file ../resources/example-pod.yml . The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack: import { Renderer , Common } from \"@k8slens/extensions\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources . Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources . ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. isInstalled() simply tries to find a pod named example-pod , as a way to determine if the pod is already installed. This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code. To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components: import React from \"react\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface Props { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < Props > { constructor ( props : Props ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount() ). The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress . The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled() . The inProgress value is true while waiting for the feature to be installed (or uninstalled). Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a \"waiting\" animation while the install (or uninstall) is in progress. Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel. Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. The ExampleClusterFeatureSettings class is marked as an @observer , and its constructor must call makeObservable() . As well, the installed and inProgress fields are marked as @observable , ensuring that the button gets rerendered any time these fields change. Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. The ExampleExtension would look like this: import { Common , Renderer } from \"@k8slens/extensions\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => { return ( < ExampleClusterFeatureSettings cluster = { entity } /> ); } } } ]; } An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. Because Lens's catalog can contain different kinds of entities, the kind must be identified. For more details about the catalog see the Catalog Guide . Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50. The final result looks like this: ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.","title":"Resource Stack"},{"location":"extensions/guides/resource-stack/#resource-stack-cluster-feature","text":"A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the life cycle of the resource stack. It could be applied automatically to a cluster by the extension, or the end-user could be required to install it. The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable 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 resource stack in this example consists of a single kubernetes resource: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx It is simply a pod named example-pod , running nginx. Assume this content is in the file ../resources/example-pod.yml . The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack: import { Renderer , Common } from \"@k8slens/extensions\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources . Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources . ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. isInstalled() simply tries to find a pod named example-pod , as a way to determine if the pod is already installed. This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code. To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components: import React from \"react\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface Props { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < Props > { constructor ( props : Props ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount() ). The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress . The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled() . The inProgress value is true while waiting for the feature to be installed (or uninstalled). Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a \"waiting\" animation while the install (or uninstall) is in progress. Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel. Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. The ExampleClusterFeatureSettings class is marked as an @observer , and its constructor must call makeObservable() . As well, the installed and inProgress fields are marked as @observable , ensuring that the button gets rerendered any time these fields change. Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. The ExampleExtension would look like this: import { Common , Renderer } from \"@k8slens/extensions\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => { return ( < ExampleClusterFeatureSettings cluster = { entity } /> ); } } } ]; } An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. Because Lens's catalog can contain different kinds of entities, the kind must be identified. For more details about the catalog see the Catalog Guide . Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50. The final result looks like this: ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.","title":"Resource Stack (Cluster Feature)"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore . ExtensionStore # Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted. Store.ExtensionStore 's child class will need to be created before being used. It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. It is also recommenced to delete the instance, using the inherited static method resetInstance() , in your extension's onDeactivate() method. Everywhere else in your code you should use the getInstance() static method. This is so that your data is kept up to date and not persisted longer than expected. The following example code creates a store for the appPreferences guide example: import { Common } from \"@k8slens/extensions\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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. Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate() , and exported for use by other parts of the extension. Note that ExamplePreferencesStore is a singleton. Calling this function will create an instance if one has not been made before. Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. This provides some logical safety in that it limits where a new instance can be created. Thus it prevents an instance from being created when the constructor args are not present at the call site. If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance. 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 { Main } from \"@k8slens/extensions\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().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 { Renderer } 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 Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the ExamplePreferencesStore .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore .","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted. Store.ExtensionStore 's child class will need to be created before being used. It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. It is also recommenced to delete the instance, using the inherited static method resetInstance() , in your extension's onDeactivate() method. Everywhere else in your code you should use the getInstance() static method. This is so that your data is kept up to date and not persisted longer than expected. The following example code creates a store for the appPreferences guide example: import { Common } from \"@k8slens/extensions\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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. Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate() , and exported for use by other parts of the extension. Note that ExamplePreferencesStore is a singleton. Calling this function will create an instance if one has not been made before. Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. This provides some logical safety in that it limits where a new instance can be created. Thus it prevents an instance from being created when the constructor args are not present at the call site. If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance. 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 { Main } from \"@k8slens/extensions\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().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 { Renderer } 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 Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the ExamplePreferencesStore .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with MobX # Introduction # Lens uses MobX on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism. You can review how React handles state management here . The following is a quick overview: React.Component is generic with respect to both props and state (which default to the empty object type). props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component. state is a component's internal state, and can be read by accessing the super-class field state . state must be updated using the setState parent method which merges the new data with the old state. React does some optimizations around re-rendering components after quick successions of setState calls. How MobX Works: # MobX is a package that provides an abstraction over React's state management system. The three main concepts are: observable is a marker for data stored in the component's state . action is a function that modifies any observable data. computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count . Further reading is available on the MobX website .","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"Lens uses MobX on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism. You can review how React handles state management here . The following is a quick overview: React.Component is generic with respect to both props and state (which default to the empty object type). props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component. state is a component's internal state, and can be read by accessing the super-class field state . state must be updated using the setState parent method which merges the new data with the old state. React does some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"MobX is a package that provides an abstraction over React's state management system. The three main concepts are: observable is a marker for data stored in the component's state . action is a function that modifies any observable data. computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count . Further reading is available on the MobX website .","title":"How MobX Works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball. Places To Host Your Extension # We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package. Publishing via NPM # This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file. Making a NPM Tarball of Your Extension # While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#publishing-extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # UI components in 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 { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; 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)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","text":"UI components in 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 { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; const GlobalPageMenuIcon = ({ navigate } : { navigate ?: () => void }) : JSX . Element => ( < Icon material = \"trip_origin\" onClick = {() => navigate ()} data - testid = \"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","text":"Code in the extension'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.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done. Installing an Extension # There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an Extension # Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run. Uninstalling an Extension # If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Uninstalling an Extension"}]} \ No newline at end of file diff --git a/v5.2.6/sitemap.xml b/v5.2.6/sitemap.xml new file mode 100644 index 0000000000..d3c1103555 --- /dev/null +++ b/v5.2.6/sitemap.xml @@ -0,0 +1,1373 @@ + + + + https://api-docs.k8slens.dev/v5.2.6/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/extension-migration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.catalogcategory/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.catalogentity/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.generalcategory/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.generalentity/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.kubernetescluster/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.weblink/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.catalog.weblinkcategory/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.store.extensionstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/common.util.singleton/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/main.catalog.catalogentityregistry/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/main.ipc/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/main.lensextension/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.catalog.catalogentityregistry/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.badge/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.barchart/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.button/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.checkbox/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.commandoverlay/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.confirmdialog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.dialog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.drawer/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.draweritem/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.drawerparamtoggler/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.drawertitle/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.icon/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.input/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.kubeeventdetails/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.kubeobjectdetails/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.kubeobjectlistlayout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmenu/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.kubeobjectmeta/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.lineprogress/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.mainlayout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.menu/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.menuactions/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.menuitem/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.namespaceselect/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.namespaceselectfilter/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.notifications/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.notificationsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.pagelayout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.piechart/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.poddetailslist/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.radio/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.radiogroup/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.searchinput/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.select/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.settinglayout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.slider/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.spinner/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.statusbrick/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.stepper/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.subtitle/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tab/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.table/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tablecell/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tablehead/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tablerow/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tabs/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.terminalstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.tooltip/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.wizard/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.wizardlayout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.component.wizardstep/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.ipc/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrole/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.clusterrolebinding/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.configmap/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.configmapsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.crdresourcestore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.crdstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjob/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.cronjobstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.customresourcedefinition/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonset/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.daemonsetstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.deployment/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.deploymentstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.endpoint/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.endpointstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.eventstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.horizontalpodautoscaler/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.hpastore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.ingress/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.ingressstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.job/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.jobstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeevent/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobject/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.kubeobjectstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrange/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.limitrangesstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.namespace/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.namespacestore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicy/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.networkpolicystore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.node/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.nodesstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolume/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaim/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumeclaimsapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.pod/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudget/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.podsapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.podsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.replicaset/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.replicasetstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequota/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcequotasstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.resourcestack/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.role/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebinding/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.rolebindingsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.rolesstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.secret/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.secretsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.service/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccount/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.servicestore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulset/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.statefulsetstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclass/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.storageclassstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.k8sapi.volumeclaimstore/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.lensextension/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/classes/renderer.navigation.pageparam/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/enums/renderer.component.notificationstatus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/enums/renderer.component.tooltipposition/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/enums/renderer.k8sapi.kubeobjectstatuslevel/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryevents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryspec/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogcategoryversion/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityactioncontext/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenu/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentityaddmenucontext/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenu/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitycontextmenucontext/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitydata/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitykinddata/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitymetadata/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingscontext/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitysettingsmenu/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.catalogentitystatus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclustermetadata/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterprometheusmetrics/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterspec/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.kubernetesclusterstatus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.catalog.weblinkstatus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.apppreferencecomponents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.apppreferenceregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenucomponents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.clusterpagemenuregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailcomponents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.kubeobjectdetailregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenucomponents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.kubeobjectmenuregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.kubeobjectstatusregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.pagecomponentprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.pagecomponents/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.pageparams/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.pageregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.pagetarget/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.protocolhandlerregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.protocolroutehandler/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.protocolrouteparams/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.registeredpage/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/common.types.statusbarregistration/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.badgeprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.buttonprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.checkboxprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogbooleanparams/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogparams/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.confirmdialogprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.dialogprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.draweritemlabelsprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.draweritemprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.drawerparamtogglerprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.drawerprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.drawertitleprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.groupselectoption/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.icondatafnarg/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.iconprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.inputvalidator/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.kubeeventdetailsprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectdetailsprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectlistlayoutprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.kubeobjectmetaprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.lineprogressprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.menuactionsprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.menuitemprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.menuposition/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.menuprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.notification/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.radiogroupprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.selectoption/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.selectprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.settinglayoutprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.sliderprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.spinnerprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.statusbrickprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.stepperprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tablayoutroute/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tablecellprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tableheadprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tableprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tablerowprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tabprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tabsprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tooltipcontentformatters/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tooltipdecoratorprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.tooltipprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.wizardlayoutprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.wizardprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.component.wizardstepprops/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ikubeapicluster/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainer/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.k8sapi.ipodcontainerstatus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.k8sapi.isecretref/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.navigation.pageparaminit/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/interfaces/renderer.navigation.urlparams/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.app/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.catalog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.eventbus/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.store/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.types/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/common.util/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/main.catalog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/main.k8sapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/main/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/main.navigation/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer.catalog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer.component/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer.k8sapi/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer.navigation/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/api/modules/renderer.theme/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/capabilities/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/capabilities/common-capabilities/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/capabilities/styling/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/get-started/anatomy/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/get-started/overview/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/get-started/wrapping-up/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/get-started/your-first-extension/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/anatomy/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/catalog/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/components/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/generator/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/ipc/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/kube-object-list-layout/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/main-extension/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/protocol-handlers/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/renderer-extension/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/resource-stack/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/stores/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/guides/working-with-mobx/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/testing-and-publishing/bundling/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/testing-and-publishing/publishing/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/testing-and-publishing/testing/ + 2021-11-04 + daily + + + https://api-docs.k8slens.dev/v5.2.6/extensions/usage/ + 2021-11-04 + daily + + \ No newline at end of file diff --git a/v5.2.6/sitemap.xml.gz b/v5.2.6/sitemap.xml.gz new file mode 100644 index 0000000000..9482b4e01e Binary files /dev/null and b/v5.2.6/sitemap.xml.gz differ diff --git a/v5.2.6/stylesheets/extra.css b/v5.2.6/stylesheets/extra.css new file mode 100644 index 0000000000..3f7e4560d7 --- /dev/null +++ b/v5.2.6/stylesheets/extra.css @@ -0,0 +1,115 @@ +:root { + --md-primary-fg-color: #3d90ce; + --md-accent-fg-color: #3d90ce; +} + +:root > * { + /* Footer */ + --md-footer-bg-color: #e8e8e8; + --md-footer-bg-color--dark: #cccdcf; + --md-footer-fg-color: #3d90ce; + --md-footer-fg-color--light: #fff; + + /* Background */ + --md-default-bg-color: #f1f1f1; +} + +[data-md-color-scheme="slate"] { + /* Footer */ + --md-footer-bg-color: #2e3136; + --md-footer-bg-color--dark: #262b2f; + --md-footer-fg-color: #3d90ce; + --md-footer-fg-color--light: #fff; + + /* Background */ + --md-default-bg-color: #1e2124; +} + +.md-version__list { + overflow: auto; +} + +.md-header-nav__title { + margin-left: 0; +} + +.md-header__title { + margin-left: 0; +} + +ul.video-list { + counter-reset: section; + list-style: none; + padding-left: 0; + position:relative +} + +ul.video-list .video:not(:last-of-type) a { + border-bottom:2px solid #e6e6e6 +} + +ul.video-list a { + position: relative; + padding: 2rem 2rem 2rem 4.2rem; + display: block; + box-sizing:border-box +} + +ul.video-list a .info { + padding-top:0.25rem +} + +ul.video-list a .info::before { + counter-increment: section; + content: counter(section); + position: absolute; + left: 1.5rem; + color:black +} + +ul.video-list a .info > p, ul.video-list a .info > span { + color:black +} + +ul.video-list a .info .title { + margin-top: 0; + margin-bottom:0.7rem +} + +ul.video-list a .info .description { + margin-bottom: 1rem; + +} + +ul.video-list a .info .duration, ul.video-list a .info .duration span { + color: #6e6e6e; + +} + +ul.video-list a:hover, ul.video-list a:focus { + text-decoration:none +} + +ul.video-list a:hover { + background:#f2f2f2 +} + +ul.video-list a:hover::after { + content: ''; + display: block; + width: 6rem; + height: 6rem; + position: absolute; + background: url("/img/play.svg"); + background-size: 6rem; + top: 3rem; + left:8.6rem +} + +ul.video-list .thumb { + max-height: 8.2rem; + padding-right: 2rem; + position: relative; + float:left +} + diff --git a/versions.json b/versions.json index d028c48807..3692257378 100644 --- a/versions.json +++ b/versions.json @@ -1 +1 @@ -[{"version": "v5.2.5", "title": "v5.2.5", "aliases": ["latest"]}, {"version": "v5.2.4", "title": "v5.2.4", "aliases": []}, {"version": "v5.2.3", "title": "v5.2.3", "aliases": []}, {"version": "v5.2.2", "title": "v5.2.2", "aliases": []}, {"version": "v5.2.1", "title": "v5.2.1", "aliases": []}, {"version": "v5.1.2", "title": "v5.1.2", "aliases": []}, {"version": "v5.1.0", "title": "v5.1.0", "aliases": []}, {"version": "v5.0.2", "title": "v5.0.2", "aliases": []}, {"version": "v5.0.0", "title": "v5.0.0", "aliases": []}, {"version": "v4.2.5", "title": "v4.2.5", "aliases": []}, {"version": "v4.2.4", "title": "v4.2.4", "aliases": []}, {"version": "v4.1.5", "title": "v4.1.5", "aliases": []}, {"version": "v4.0.8", "title": "v4.0.8", "aliases": []}, {"version": "master", "title": "master", "aliases": []}] \ No newline at end of file +[{"version": "v5.2.6", "title": "v5.2.6", "aliases": ["latest"]}, {"version": "v5.2.5", "title": "v5.2.5", "aliases": []}, {"version": "v5.2.4", "title": "v5.2.4", "aliases": []}, {"version": "v5.2.3", "title": "v5.2.3", "aliases": []}, {"version": "v5.2.2", "title": "v5.2.2", "aliases": []}, {"version": "v5.2.1", "title": "v5.2.1", "aliases": []}, {"version": "v5.1.2", "title": "v5.1.2", "aliases": []}, {"version": "v5.1.0", "title": "v5.1.0", "aliases": []}, {"version": "v5.0.2", "title": "v5.0.2", "aliases": []}, {"version": "v5.0.0", "title": "v5.0.0", "aliases": []}, {"version": "v4.2.5", "title": "v4.2.5", "aliases": []}, {"version": "v4.2.4", "title": "v4.2.4", "aliases": []}, {"version": "v4.1.5", "title": "v4.1.5", "aliases": []}, {"version": "v4.0.8", "title": "v4.0.8", "aliases": []}, {"version": "master", "title": "master", "aliases": []}] \ No newline at end of file