-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
65 changed files
with
1,510 additions
and
238 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [App](./kibana-plugin-public.app.md) | ||
|
||
## App interface | ||
|
||
Extension of 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: ApplicationContext, targetDomElement: HTMLElement) => AppUnmount | Promise<AppUnmount></code> | A mount function called when the user navigates to this app's <code>rootRoute</code>. | | ||
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.app.mount.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [App](./kibana-plugin-public.app.md) > [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: ApplicationContext, targetDomElement: HTMLElement) => AppUnmount | Promise<AppUnmount>; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.capabilities.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [capabilities](./kibana-plugin-public.appbase.capabilities.md) | ||
|
||
## AppBase.capabilities property | ||
|
||
Custom capabilities defined by the app. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
capabilities?: Partial<Capabilities>; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.euiicontype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [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; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.icon.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [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; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.appbase.id.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [id](./kibana-plugin-public.appbase.id.md) | ||
|
||
## AppBase.id property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
id: string; | ||
``` |
25 changes: 25 additions & 0 deletions
25
docs/development/core/public/kibana-plugin-public.appbase.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [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<Capabilities></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<string></code> | An observable for a tooltip shown when hovering over app link. | | ||
|
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.order.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [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; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.title.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [title](./kibana-plugin-public.appbase.title.md) | ||
|
||
## AppBase.title property | ||
|
||
The title of the application. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
title: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.tooltip$.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [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>; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/public/kibana-plugin-public.applicationcontext.core.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationContext](./kibana-plugin-public.applicationcontext.md) > [core](./kibana-plugin-public.applicationcontext.core.md) | ||
|
||
## ApplicationContext.core property | ||
|
||
Core service APIs available to mounted applications. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
core: { | ||
chrome: ChromeStart; | ||
docLinks: DocLinksStart; | ||
http: HttpStart; | ||
i18n: I18nStart; | ||
notifications: NotificationsStart; | ||
overlays: OverlayStart; | ||
uiSettings: UiSettingsClientContract; | ||
}; | ||
``` |
26 changes: 26 additions & 0 deletions
26
docs/development/core/public/kibana-plugin-public.applicationcontext.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationContext](./kibana-plugin-public.applicationcontext.md) | ||
|
||
## ApplicationContext interface | ||
|
||
The context object received when applications are mounted to the DOM. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ApplicationContext | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [core](./kibana-plugin-public.applicationcontext.core.md) | <code>{</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. | | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [navigateToApp(appId, path)](./kibana-plugin-public.applicationcontext.navigatetoapp.md) | Unmounts the current application and navigates to the given app and optional path. | | ||
|
25 changes: 25 additions & 0 deletions
25
...evelopment/core/public/kibana-plugin-public.applicationcontext.navigatetoapp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationContext](./kibana-plugin-public.applicationcontext.md) > [navigateToApp](./kibana-plugin-public.applicationcontext.navigatetoapp.md) | ||
|
||
## ApplicationContext.navigateToApp() method | ||
|
||
Unmounts the current application and navigates to the given app and optional path. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
navigateToApp(appId: string, path?: string): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| appId | <code>string</code> | | | ||
| path | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
...pment/core/public/kibana-plugin-public.applicationsetup.registermountcontext.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationSetup](./kibana-plugin-public.applicationsetup.md) > [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 ApplicationContext>(pluginOpaqueId: PluginOpaqueId, contextName: T, provider: IContextProvider<ApplicationContext, keyof ApplicationContext>): void; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| pluginOpaqueId | <code>PluginOpaqueId</code> | The opaque ID of the plugin that is registering the context. | | ||
| contextName | <code>T</code> | The key of [ApplicationContext](./kibana-plugin-public.applicationcontext.md) this provider's return value should be attached to. | | ||
| provider | <code>IContextProvider<ApplicationContext, keyof ApplicationContext></code> | A [IContextProvider](./kibana-plugin-public.icontextprovider.md) function | | ||
<b>Returns:</b> | ||
`void` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
.../development/core/public/kibana-plugin-public.applicationstart.navigatetoapp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationStart](./kibana-plugin-public.applicationstart.md) > [navigateToApp](./kibana-plugin-public.applicationstart.navigatetoapp.md) | ||
|
||
## ApplicationStart.navigateToApp() method | ||
|
||
Navigiate to a given app | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
navigateToApp(appId: string, path?: string): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| appId | <code>string</code> | | | ||
| path | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
26 changes: 26 additions & 0 deletions
26
...pment/core/public/kibana-plugin-public.applicationstart.registermountcontext.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ApplicationStart](./kibana-plugin-public.applicationstart.md) > [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 ApplicationContext>(pluginOpaqueId: PluginOpaqueId, contextName: T, provider: IContextProvider<ApplicationContext, T>): void; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| pluginOpaqueId | <code>PluginOpaqueId</code> | The opaque ID of the plugin that is registering the context. | | ||
| contextName | <code>T</code> | The key of [ApplicationContext](./kibana-plugin-public.applicationcontext.md) this provider's return value should be attached to. | | ||
| provider | <code>IContextProvider<ApplicationContext, T></code> | A [IContextProvider](./kibana-plugin-public.icontextprovider.md) function | | ||
<b>Returns:</b> | ||
`void` | ||
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appunmount.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppUnmount](./kibana-plugin-public.appunmount.md) | ||
|
||
## AppUnmount type | ||
|
||
A function called when an application should be unmounted from the page. This function should be synchronous. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type AppUnmount = () => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.coresetup.application.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [application](./kibana-plugin-public.coresetup.application.md) | ||
|
||
## CoreSetup.application property | ||
|
||
[ApplicationSetup](./kibana-plugin-public.applicationsetup.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
application: ApplicationSetup; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.