Drilldowns in examples

src/plugins/dashboard/public/index.ts

@@ -31,7 +31,12 @@ export {
 } from './application';
 export { DashboardConstants, createDashboardEditUrl } from './dashboard_constants';
 
-export { DashboardStart, DashboardUrlGenerator, DashboardFeatureFlagConfig } from './plugin';
+export {
+  DashboardSetup,
+  DashboardStart,
+  DashboardUrlGenerator,
+  DashboardFeatureFlagConfig,
+} from './plugin';
 export {
   DASHBOARD_APP_URL_GENERATOR,
   createDashboardUrlGenerator,

src/plugins/dashboard/public/plugin.tsx

@@ -145,7 +145,7 @@ interface StartDependencies {
   savedObjects: SavedObjectsStart;
 }
 
-export type Setup = void;
+export type DashboardSetup = void;
 
 export interface DashboardStart {
   getSavedDashboardLoader: () => SavedObjectLoader;
@@ -180,7 +180,7 @@ declare module '../../../plugins/ui_actions/public' {
 }
 
 export class DashboardPlugin
-  implements Plugin<Setup, DashboardStart, SetupDependencies, StartDependencies> {
+  implements Plugin<DashboardSetup, DashboardStart, SetupDependencies, StartDependencies> {
   constructor(private initializerContext: PluginInitializerContext) {}
 
   private appStateUpdater = new BehaviorSubject<AppUpdater>(() => ({}));
@@ -193,17 +193,8 @@ export class DashboardPlugin
 
   public setup(
     core: CoreSetup<StartDependencies, DashboardStart>,
-    {
-      share,
-      uiActions,
-      embeddable,
-      home,
-      kibanaLegacy,
-      urlForwarding,
-      data,
-      usageCollection,
-    }: SetupDependencies
-  ): Setup {
+    { share, uiActions, embeddable, home, urlForwarding, data, usageCollection }: SetupDependencies
+  ): DashboardSetup {
     this.dashboardFeatureFlagConfig = this.initializerContext.config.get<
       DashboardFeatureFlagConfig
     >();

src/plugins/share/public/index.ts

@@ -40,4 +40,6 @@ export {
 
 import { SharePlugin } from './plugin';
 
+export { KibanaURL } from './kibana_url';
+
 export const plugin = () => new SharePlugin();

src/plugins/share/public/kibana_url.ts

@@ -0,0 +1,44 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// TODO: Replace this logic with KibanaURL once it is available.
+// https://github.com/elastic/kibana/issues/64497
+export class KibanaURL {
+  public readonly path: string;
+  public readonly appName: string;
+  public readonly appPath: string;
+
+  constructor(path: string) {
+    const match = path.match(/^.*\/app\/([^\/#]+)(.+)$/);
+
+    if (!match) {
+      throw new Error('Unexpected URL path.');
+    }
+
+    const [, appName, appPath] = match;
+
+    if (!appName || !appPath) {
+      throw new Error('Could not parse URL path.');
+    }
+
+    this.path = path;
+    this.appName = appName;
+    this.appPath = appPath;
+  }
+}

x-pack/examples/ui_actions_enhanced_examples/README.md

@@ -5,7 +5,8 @@ To run this example plugin, use the command `yarn start --run-examples`.
 
 ## Drilldown examples
 
-This plugin holds few examples on how to add drilldown types to dashboard.
+This plugin holds few examples on how to add drilldown types to dashboard. See
+`./public/drilldowns/` folder.
 
 To play with drilldowns, open any dashboard, click "Edit" to put it in *edit mode*.
 Now when opening context menu of dashboard panels you should see "Create drilldown" option.
@@ -34,3 +35,74 @@ One can see how middle-click or Ctrl + click behavior could be supported using
 ### `dashboard_to_discover_drilldown`
 
 `dashboard_to_discover_drilldown` shows how a real-world drilldown could look like.
+
+
+## Drilldown Manager examples
+
+*Drilldown Manager* is a collectio of code and React components that allows you
+to add drilldowns to any app. To see examples of how drilldows can be added to
+your app, run Kibana with `--run-examples` flag:
+
+```
+yarn start --run-examples
+```
+
+Then go to "Developer examples" and "UI Actions Enhanced", where you can see examples
+where *Drilldown Manager* is used outside of the Dashboard app:
+
+![image](https://user-images.githubusercontent.com/9773803/94044547-969a3400-fdce-11ea-826a-cbd0773a4000.png)
+
+These examples show how you can create your custom UI Actions triggers and add
+drilldowns to them, or use an embeddable in your app and add drilldows to it.
+
+
+### Trigger examples
+
+The `/public/triggers` folder shows how you can create custom triggers for your app.
+Triggers are things that trigger some action in UI, like "user click".
+
+Once you have defined your triggers, you need to register them in your plugin:
+
+```ts
+export class MyPlugin implements Plugin {
+  public setup(core, { uiActionsEnhanced: uiActions }: SetupDependencies) {
+    uiActions.registerTrigger(myTrigger);
+  }
+}
+```
+
+### `app1_hello_world_drilldown`
+
+`app1_hello_world_drilldown` is a basic example that shows how you can add the most
+basic drilldown to your custom trigger.
+
+### `appx_to_dashboard_drilldown`
+
+`app1_to_dashboard_drilldown` and `app2_to_dashboard_drilldown` show how the Dashboard
+drilldown can be used in other apps, outside of Dashboard.
+
+Basically you define it:
+
+```ts
+type Trigger = typeof MY_TRIGGER_TRIGGER;
+type Context = MyAppClickContext;
+
+export class App1ToDashboardDrilldown extends AbstractDashboardDrilldown<Trigger> {
+  public readonly supportedTriggers = () => [MY_TRIGGER] as Trigger[];
+
+  protected async getURL(config: Config, context: Context): Promise<KibanaURL> {
+    return 'https://...';
+  }
+}
+```
+
+and then you register it in your plugin:
+
+```ts
+export class MyPlugin implements Plugin {
+  public setup(core, { uiActionsEnhanced: uiActions }: SetupDependencies) {
+    const drilldown = new App2ToDashboardDrilldown(/* You can pass in dependencies here. */);
+    uiActions.registerDrilldown(drilldown);
+  }
+}
+```

x-pack/examples/ui_actions_enhanced_examples/kibana.json

@@ -5,10 +5,21 @@
   "configPath": ["ui_actions_enhanced_examples"],
   "server": false,
   "ui": true,
-  "requiredPlugins": ["uiActions","uiActionsEnhanced", "data", "discover"],
+  "requiredPlugins": [
+    "uiActions",
+    "uiActionsEnhanced",
+    "data",
+    "discover",
+    "dashboard",
+    "dashboardEnhanced",
+    "developerExamples"
+  ],
   "optionalPlugins": [],
   "requiredBundles": [
+    "dashboardEnhanced",
+    "embeddable",
     "kibanaUtils",
-    "kibanaReact"
+    "kibanaReact",
+    "share"
   ]
 }

x-pack/examples/ui_actions_enhanced_examples/public/components/page/index.tsx

@@ -0,0 +1,38 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as React from 'react';
+import {
+  EuiPageBody,
+  EuiPageContent,
+  EuiPageContentBody,
+  EuiPageHeader,
+  EuiPageHeaderSection,
+  EuiTitle,
+} from '@elastic/eui';
+
+export interface PageProps {
+  title?: React.ReactNode;
+}
+
+export const Page: React.FC<PageProps> = ({ title = 'Untitled', children }) => {
+  return (
+    <EuiPageBody style={{ maxWidth: 1200, margin: '0 auto' }}>
+      <EuiPageHeader>
+        <EuiPageHeaderSection>
+          <EuiTitle size="l">
+            <h1>{title}</h1>
+          </EuiTitle>
+        </EuiPageHeaderSection>
+      </EuiPageHeader>
+      <EuiPageContent>
+        <EuiPageContentBody style={{ maxWidth: 800, margin: '0 auto' }}>
+          {children}
+        </EuiPageContentBody>
+      </EuiPageContent>
+    </EuiPageBody>
+  );
+};

x-pack/examples/ui_actions_enhanced_examples/public/components/section/index.tsx

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export * from './section';

x-pack/examples/ui_actions_enhanced_examples/public/components/section/section.tsx

@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React from 'react';
+import { EuiTitle, EuiSpacer } from '@elastic/eui';
+
+export interface Props {
+  title: React.ReactNode;
+}
+
+export const Section: React.FC<Props> = ({ title, children }) => {
+  return (
+    <section>
+      <EuiTitle size="m">
+        <h2>{title}</h2>
+      </EuiTitle>
+      <EuiSpacer />
+      {children}
+    </section>
+  );
+};

x-pack/examples/ui_actions_enhanced_examples/public/containers/app/app.tsx

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React from 'react';
+import { EuiPage } from '@elastic/eui';
+import { Page } from '../../components/page';
+import { DrilldownsManager } from '../drilldowns_manager';
+
+export const App: React.FC = () => {
+  return (
+    <EuiPage>
+      <Page title={'UI Actions Enhanced'}>
+        <DrilldownsManager />
+      </Page>
+    </EuiPage>
+  );
+};

x-pack/examples/ui_actions_enhanced_examples/public/containers/app/index.tsx

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export * from './app';

x-pack/examples/ui_actions_enhanced_examples/public/containers/drilldowns_manager/drilldowns_manager.tsx

@@ -0,0 +1,39 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { EuiHorizontalRule } from '@elastic/eui';
+import React from 'react';
+import { Section } from '../../components/section/section';
+import { SampleMlJob, SampleApp1ClickContext } from '../../triggers';
+import { DrilldownsWithoutEmbeddableExample } from '../drilldowns_without_embeddable_example';
+import { DrilldownsWithoutEmbeddableSingleButtonExample } from '../drilldowns_without_embeddable_single_button_example/drilldowns_without_embeddable_single_button_example';
+import { DrilldownsWithEmbeddableExample } from '../drilldowns_with_embeddable_example';
+
+export const job: SampleMlJob = {
+  job_id: '123',
+  job_type: 'anomaly_detector',
+  description: 'This is some ML job.',
+};
+
+export const context: SampleApp1ClickContext = { job };
+
+export const DrilldownsManager: React.FC = () => {
+  return (
+    <div>
+      <Section title={'Drilldowns Manager'}>
+        <DrilldownsWithoutEmbeddableExample />
+
+        <EuiHorizontalRule margin="xxl" />
+
+        <DrilldownsWithoutEmbeddableSingleButtonExample />
+
+        <EuiHorizontalRule margin="xxl" />
+
+        <DrilldownsWithEmbeddableExample />
+      </Section>
+    </div>
+  );
+};

x-pack/examples/ui_actions_enhanced_examples/public/containers/drilldowns_manager/index.tsx

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export * from './drilldowns_manager';