doc: update readme

Signed-off-by: tygao <tygao@amazon.com>
raintygao · Mar 2, 2024 · cad2401 · cad2401
1 parent c7ddbda
commit cad2401
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git 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
@@ -153,6 +153,7 @@ class MyPlugin {
 
 - `overlays.openModal` &mdash; opens modal window.
 - `overlays.openFlyout` &mdash; opens right side panel.
+- `overlays.sidecar().open` &mdash; opens sidecar.
 
 You can access `overlays` service through React context.