maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

move the example app to be mounted in the developerExamples plugin instead of visible in navbar (#101464) (#102052)

Browse source 
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
This commit is contained in:
Kibana Machine 2021-06-14 10:53:25 -04:00 committed by GitHub
parent ccc120843c
commit 15aaecf057
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/screenshot_mode_example/kibana.json
View file

@ -4,6 +4,6 @@
"kibanaVersion": "kibana", "kibanaVersion": "kibana",
"server": true, "server": true,
"ui": true, "ui": true,
"requiredPlugins": ["navigation", "screenshotMode", "usageCollection"], "requiredPlugins": ["navigation", "screenshotMode", "usageCollection", "developerExamples"],
"optionalPlugins": [] "optionalPlugins": []
} }

18
examples/screenshot_mode_example/public/plugin.ts
View file

@ -6,7 +6,13 @@
* Side Public License, v 1. * 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 { AppPluginSetupDependencies, AppPluginStartDependencies } from './types';
import { MetricsTracking } from './services'; import { MetricsTracking } from './services';
import { PLUGIN_NAME } from '../common'; import { PLUGIN_NAME } from '../common';
@ -15,7 +21,7 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
uiTracking = new MetricsTracking(); uiTracking = new MetricsTracking();
public setup(core: CoreSetup, depsSetup: AppPluginSetupDependencies): void { public setup(core: CoreSetup, depsSetup: AppPluginSetupDependencies): void {
const { screenshotMode, usageCollection } = depsSetup; const { screenshotMode, usageCollection, developerExamples } = depsSetup;
const isScreenshotMode = screenshotMode.isScreenshotMode(); const isScreenshotMode = screenshotMode.isScreenshotMode();
this.uiTracking.setup({ this.uiTracking.setup({
@ -27,6 +33,7 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
core.application.register({ core.application.register({
id: 'screenshotModeExample', id: 'screenshotModeExample',
title: PLUGIN_NAME, title: PLUGIN_NAME,
navLinkStatus: AppNavLinkStatus.hidden,
async mount(params: AppMountParameters) { async mount(params: AppMountParameters) {
// Load application bundle // Load application bundle
const { renderApp } = await import('./application'); const { renderApp } = await import('./application');
@ -40,6 +47,13 @@ export class ScreenshotModeExamplePlugin implements Plugin<void, void> {
return renderApp(coreStart, depsSetup, depsStart as AppPluginStartDependencies, params); 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 {} public start(core: CoreStart): void {}

2
examples/screenshot_mode_example/public/types.ts
View file

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