From 3a3e9e45ab4787edc8665d35c91d9634bdf23f12 Mon Sep 17 00:00:00 2001 From: tygao Date: Mon, 26 Feb 2024 18:31:25 +0800 Subject: [PATCH] doc: update readme Signed-off-by: tygao --- src/core/public/public.api.md | 2 ++ src/plugins/opensearch_dashboards_react/README.md | 1 + 2 files changed, 3 insertions(+) diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md index 883b62de50ff..c72e7e32f5f4 100644 --- a/src/core/public/public.api.md +++ b/src/core/public/public.api.md @@ -1110,6 +1110,8 @@ export interface OverlayStart { // // (undocumented) openModal: OverlayModalStart['open']; + // (undocumented) + sidecar: OverlaySidecarStart; } export { PackageInfo } diff --git a/src/plugins/opensearch_dashboards_react/README.md b/src/plugins/opensearch_dashboards_react/README.md index bc8bfcf0266c..f5f4cd5efe79 100644 --- a/src/plugins/opensearch_dashboards_react/README.md +++ b/src/plugins/opensearch_dashboards_react/README.md @@ -153,6 +153,7 @@ class MyPlugin { - `overlays.openModal` — opens modal window. - `overlays.openFlyout` — opens right side panel. +- `overlays.sidecar().open` — opens sidecar. You can access `overlays` service through React context.