move the example app to be mounted in the developerExamples plugin in…

…stead of visible in navbar
elastic · Jun 7, 2021 · c6a7247 · c6a7247
1 parent e3198bc
commit c6a7247
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/examples/screenshot_mode_example/kibana.json b/examples/screenshot_mode_example/kibana.json
@@ -4,6 +4,6 @@
   "kibanaVersion": "kibana",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["navigation", "screenshotMode", "usageCollection"],
+  "requiredPlugins": ["navigation", "screenshotMode", "usageCollection", "developerExamples"],
   "optionalPlugins": []
 }
diff --git a/examples/screenshot_mode_example/public/plugin.ts b/examples/screenshot_mode_example/public/plugin.ts
@@ -6,7 +6,13 @@
  * Side Public License, v 1.
  */
 
-import { AppMountParameters, CoreSetup, CoreStart, Plugin } from '../../../src/core/public';
+import {
+  AppMountParameters,
+  CoreSetup,
+  CoreStart,
+  Plugin,
+  AppNavLinkStatus,
+} from '../../../src/core/public';
 import { AppPluginSetupDependencies, AppPluginStartDependencies } from './types';
 import { MetricsTracking } from './services';
 import { PLUGIN_NAME } from '../common';
@@ -15,7 +21,7 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
   uiTracking = new MetricsTracking();
 
   public setup(core: CoreSetup, depsSetup: AppPluginSetupDependencies): void {
-    const { screenshotMode, usageCollection } = depsSetup;
+    const { screenshotMode, usageCollection, developerExamples } = depsSetup;
     const isScreenshotMode = screenshotMode.isScreenshotMode();
 
     this.uiTracking.setup({
@@ -27,6 +33,7 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
     core.application.register({
       id: 'screenshotModeExample',
       title: PLUGIN_NAME,
+      navLinkStatus: AppNavLinkStatus.hidden,
       async mount(params: AppMountParameters) {
         // Load application bundle
         const { renderApp } = await import('./application');
@@ -40,6 +47,13 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
         return renderApp(coreStart, depsSetup, depsStart as AppPluginStartDependencies, params);
       },
     });
+
+    developerExamples.register({
+      appId: 'screenshotModeExample',
+      title: 'Screenshot mode integration',
+      description:
+        'Demonstrate how a plugin can adapt appearance based on whether we are in screenshot mode',
+    });
   }
 
   public start(core: CoreStart): void {}

diff --git a/examples/screenshot_mode_example/public/types.ts b/examples/screenshot_mode_example/public/types.ts
@@ -9,10 +9,12 @@
 import { NavigationPublicPluginStart } from '../../../src/plugins/navigation/public';
 import { ScreenshotModePluginSetup } from '../../../src/plugins/screenshot_mode/public';
 import { UsageCollectionSetup } from '../../../src/plugins/usage_collection/public';
+import { DeveloperExamplesSetup } from '../../developer_examples/public';
 
 export interface AppPluginSetupDependencies {
   usageCollection: UsageCollectionSetup;
   screenshotMode: ScreenshotModePluginSetup;
+  developerExamples: DeveloperExamplesSetup;
 }
 
 export interface AppPluginStartDependencies {