Add ApplicationService Mounting

docs/development/core/public/kibana-plugin-public.app.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md)
+
+## App interface
+
+Extension of [common app properties](./kibana-plugin-public.appbase.md) with the mount function.
+
+<b>Signature:</b>
+
+```typescript
+export interface App extends AppBase 
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [mount](./kibana-plugin-public.app.mount.md) | <code>(context: AppMountContext, params: AppMountParameters) =&gt; AppUnmount &#124; Promise&lt;AppUnmount&gt;</code> | A mount function called when the user navigates to this app's <code>rootRoute</code>. |
+

docs/development/core/public/kibana-plugin-public.app.mount.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [mount](./kibana-plugin-public.app.mount.md)
+
+## App.mount property
+
+A mount function called when the user navigates to this app's `rootRoute`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+mount: (context: AppMountContext, params: AppMountParameters) => AppUnmount | Promise<AppUnmount>;
+```

docs/development/core/public/kibana-plugin-public.appbase.capabilities.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [capabilities](./kibana-plugin-public.appbase.capabilities.md)
+
+## AppBase.capabilities property
+
+Custom capabilities defined by the app.
+
+<b>Signature:</b>
+
+```typescript
+capabilities?: Partial<Capabilities>;
+```

docs/development/core/public/kibana-plugin-public.appbase.euiicontype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [euiIconType](./kibana-plugin-public.appbase.euiicontype.md)
+
+## AppBase.euiIconType property
+
+A EUI iconType that will be used for the app's icon. This icon takes precendence over the `icon` property.
+
+<b>Signature:</b>
+
+```typescript
+euiIconType?: string;
+```

docs/development/core/public/kibana-plugin-public.appbase.icon.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [icon](./kibana-plugin-public.appbase.icon.md)
+
+## AppBase.icon property
+
+A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
+
+<b>Signature:</b>
+
+```typescript
+icon?: string;
+```

docs/development/core/public/kibana-plugin-public.appbase.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [id](./kibana-plugin-public.appbase.id.md)
+
+## AppBase.id property
+
+<b>Signature:</b>
+
+```typescript
+id: string;
+```

docs/development/core/public/kibana-plugin-public.appbase.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md)
+
+## AppBase interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface AppBase 
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
+| [euiIconType](./kibana-plugin-public.appbase.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
+| [icon](./kibana-plugin-public.appbase.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
+| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | |
+| [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
+| [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
+| [tooltip$](./kibana-plugin-public.appbase.tooltip$.md) | <code>Observable&lt;string&gt;</code> | An observable for a tooltip shown when hovering over app link. |
+

docs/development/core/public/kibana-plugin-public.appbase.order.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [order](./kibana-plugin-public.appbase.order.md)
+
+## AppBase.order property
+
+An ordinal used to sort nav links relative to one another for display.
+
+<b>Signature:</b>
+
+```typescript
+order?: number;
+```

docs/development/core/public/kibana-plugin-public.appbase.title.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [title](./kibana-plugin-public.appbase.title.md)
+
+## AppBase.title property
+
+The title of the application.
+
+<b>Signature:</b>
+
+```typescript
+title: string;
+```

docs/development/core/public/kibana-plugin-public.appbase.tooltip$.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [tooltip$](./kibana-plugin-public.appbase.tooltip$.md)
+
+## AppBase.tooltip$ property
+
+An observable for a tooltip shown when hovering over app link.
+
+<b>Signature:</b>
+
+```typescript
+tooltip$?: Observable<string>;
+```

docs/development/core/public/kibana-plugin-public.applicationsetup.md

@@ -15,5 +15,6 @@ export interface ApplicationSetup
 
 | Method | Description |
 | --- | --- |
-| [registerApp(app)](./kibana-plugin-public.applicationsetup.registerapp.md) | Register an mountable application to the system. Apps will be mounted based on their <code>rootRoute</code>. |
+| [register(app)](./kibana-plugin-public.applicationsetup.register.md) | Register an mountable application to the system. Apps will be mounted based on their <code>rootRoute</code>. |
+| [registerMountContext(contextName, provider)](./kibana-plugin-public.applicationsetup.registermountcontext.md) | Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context. |
 

docs/development/core/public/kibana-plugin-public.applicationsetup.registerapp.md → docs/development/core/public/kibana-plugin-public.applicationsetup.register.md

@@ -1,22 +1,22 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationSetup](./kibana-plugin-public.applicationsetup.md) &gt; [registerApp](./kibana-plugin-public.applicationsetup.registerapp.md)
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationSetup](./kibana-plugin-public.applicationsetup.md) &gt; [register](./kibana-plugin-public.applicationsetup.register.md)
 
-## ApplicationSetup.registerApp() method
+## ApplicationSetup.register() method
 
 Register an mountable application to the system. Apps will be mounted based on their `rootRoute`<!-- -->.
 
 <b>Signature:</b>
 
 ```typescript
-registerApp(app: App): void;
+register(app: App): void;
 ```
 
 ## Parameters
 
 | Parameter | Type | Description |
 | --- | --- | --- |
-| app | <code>App</code> | |
+| app | <code>App</code> | an [App](./kibana-plugin-public.app.md) |
 
 <b>Returns:</b>
 

docs/development/core/public/kibana-plugin-public.applicationsetup.registermountcontext.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationSetup](./kibana-plugin-public.applicationsetup.md) &gt; [registerMountContext](./kibana-plugin-public.applicationsetup.registermountcontext.md)
+
+## ApplicationSetup.registerMountContext() method
+
+Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context.
+
+<b>Signature:</b>
+
+```typescript
+registerMountContext<T extends keyof AppMountContext>(contextName: T, provider: IContextProvider<AppMountContext, T>): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| contextName | <code>T</code> | The key of [AppMountContext](./kibana-plugin-public.appmountcontext.md) this provider's return value should be attached to. |
+| provider | <code>IContextProvider&lt;AppMountContext, T&gt;</code> | A [IContextProvider](./kibana-plugin-public.icontextprovider.md) function |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/public/kibana-plugin-public.applicationstart.md

@@ -15,6 +15,12 @@ export interface ApplicationStart
 
 | Property | Type | Description |
 | --- | --- | --- |
-| [availableApps](./kibana-plugin-public.applicationstart.availableapps.md) | <code>readonly App[]</code> | Apps available based on the current capabilities. Should be used to show navigation links and make routing decisions. |
 | [capabilities](./kibana-plugin-public.applicationstart.capabilities.md) | <code>RecursiveReadonly&lt;Capabilities&gt;</code> | Gets the read-only capabilities. |
 
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [navigateToApp(appId, options)](./kibana-plugin-public.applicationstart.navigatetoapp.md) | Navigiate to a given app |
+| [registerMountContext(contextName, provider)](./kibana-plugin-public.applicationstart.registermountcontext.md) | Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context. |
+

docs/development/core/public/kibana-plugin-public.applicationstart.navigatetoapp.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationStart](./kibana-plugin-public.applicationstart.md) &gt; [navigateToApp](./kibana-plugin-public.applicationstart.navigatetoapp.md)
+
+## ApplicationStart.navigateToApp() method
+
+Navigiate to a given app
+
+<b>Signature:</b>
+
+```typescript
+navigateToApp(appId: string, options?: {
+ path?: string;
+ state?: any;
+ }): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| appId | <code>string</code> | |
+| options | <code>{</code><br/><code> path?: string;</code><br/><code> state?: any;</code><br/><code> }</code> | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/public/kibana-plugin-public.applicationstart.registermountcontext.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationStart](./kibana-plugin-public.applicationstart.md) &gt; [registerMountContext](./kibana-plugin-public.applicationstart.registermountcontext.md)
+
+## ApplicationStart.registerMountContext() method
+
+Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context.
+
+<b>Signature:</b>
+
+```typescript
+registerMountContext<T extends keyof AppMountContext>(contextName: T, provider: IContextProvider<AppMountContext, T>): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| contextName | <code>T</code> | The key of [AppMountContext](./kibana-plugin-public.appmountcontext.md) this provider's return value should be attached to. |
+| provider | <code>IContextProvider&lt;AppMountContext, T&gt;</code> | A [IContextProvider](./kibana-plugin-public.icontextprovider.md) function |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/public/kibana-plugin-public.appmountcontext.core.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppMountContext](./kibana-plugin-public.appmountcontext.md) &gt; [core](./kibana-plugin-public.appmountcontext.core.md)
+
+## AppMountContext.core property
+
+Core service APIs available to mounted applications.
+
+<b>Signature:</b>
+
+```typescript
+core: {
+ application: Pick<ApplicationStart, 'capabilities' | 'navigateToApp'>;
+ chrome: ChromeStart;
+ docLinks: DocLinksStart;
+ http: HttpStart;
+ i18n: I18nStart;
+ notifications: NotificationsStart;
+ overlays: OverlayStart;
+ uiSettings: UiSettingsClientContract;
+ };
+```

docs/development/core/public/kibana-plugin-public.appmountcontext.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppMountContext](./kibana-plugin-public.appmountcontext.md)
+
+## AppMountContext interface
+
+The context object received when applications are mounted to the DOM.
+
+<b>Signature:</b>
+
+```typescript
+export interface AppMountContext 
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [core](./kibana-plugin-public.appmountcontext.core.md) | <code>{</code><br/><code> application: Pick&lt;ApplicationStart, 'capabilities' &#124; 'navigateToApp'&gt;;</code><br/><code> chrome: ChromeStart;</code><br/><code> docLinks: DocLinksStart;</code><br/><code> http: HttpStart;</code><br/><code> i18n: I18nStart;</code><br/><code> notifications: NotificationsStart;</code><br/><code> overlays: OverlayStart;</code><br/><code> uiSettings: UiSettingsClientContract;</code><br/><code> }</code> | Core service APIs available to mounted applications. |
+

docs/development/core/public/kibana-plugin-public.appmountparameters.appbasepath.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppMountParameters](./kibana-plugin-public.appmountparameters.md) &gt; [appBasePath](./kibana-plugin-public.appmountparameters.appbasepath.md)
+
+## AppMountParameters.appBasePath property
+
+The base path for configuring the application's router.
+
+<b>Signature:</b>
+
+```typescript
+appBasePath: string;
+```
+
+## Example
+
+How to configure react-router with a base path:
+
+```ts
+// inside your plugin's setup function
+export class MyPlugin implements Plugin {
+ setup({ application }) {
+ application.register({
+ id: 'my-app',
+ async mount(context, params) {
+ const { renderApp } = await import('./applcation');
+ return renderApp(context, params);
+ },
+ });
+}
+
+```
+
+```ts
+// application.tsx
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { BrowserRouter, Route } from 'react-router-dom';
+
+export renderApp = (context, { appBasePath, element }) => {
+ ReactDOM.render(
+ // pass `appBasePath` to `basename`
+ <BrowserRouter basename={appBasePath}>
+ <Route path="/" exact component={HomePage} />
+ </BrowserRouter>,
+ element
+ );
+
+ return () => ReactDOM.unmountComponentAtNode(element);
+}
+
+```
+