-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into timelion-shim
- Loading branch information
Showing
1,028 changed files
with
36,985 additions
and
8,416 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
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
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.chromeless.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) > [chromeless](./kibana-plugin-public.appbase.chromeless.md) | ||
|
||
## AppBase.chromeless property | ||
|
||
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
chromeless?: boolean; | ||
``` |
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 |
---|---|---|
|
@@ -4,6 +4,8 @@ | |
|
||
## AppBase.id property | ||
|
||
The unique identifier of the application | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
|
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
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.appbase.navlinkstatus.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) > [navLinkStatus](./kibana-plugin-public.appbase.navlinkstatus.md) | ||
|
||
## AppBase.navLinkStatus property | ||
|
||
The initial status of the application's navLink. Defaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible` See [AppNavLinkStatus](./kibana-plugin-public.appnavlinkstatus.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
navLinkStatus?: AppNavLinkStatus; | ||
``` |
8 changes: 4 additions & 4 deletions
8
.../kibana-plugin-public.appbase.tooltip_.md → ...ic/kibana-plugin-public.appbase.status.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 |
---|---|---|
@@ -1,13 +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) | ||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppBase](./kibana-plugin-public.appbase.md) > [status](./kibana-plugin-public.appbase.status.md) | ||
|
||
## AppBase.tooltip$ property | ||
## AppBase.status property | ||
|
||
An observable for a tooltip shown when hovering over app link. | ||
The initial status of the application. Defaulting to `accessible` | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
tooltip$?: Observable<string>; | ||
status?: AppStatus; | ||
``` |
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 | ||
|
||
A tooltip shown when hovering over app link. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
tooltip?: string; | ||
``` |
44 changes: 44 additions & 0 deletions
44
docs/development/core/public/kibana-plugin-public.appbase.updater_.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,44 @@ | ||
<!-- 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) > [updater$](./kibana-plugin-public.appbase.updater_.md) | ||
|
||
## AppBase.updater$ property | ||
|
||
An [AppUpdater](./kibana-plugin-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
updater$?: Observable<AppUpdater>; | ||
``` | ||
|
||
## Example | ||
|
||
How to update an application navLink at runtime | ||
|
||
```ts | ||
// inside your plugin's setup function | ||
export class MyPlugin implements Plugin { | ||
private appUpdater = new BehaviorSubject<AppUpdater>(() => ({})); | ||
|
||
setup({ application }) { | ||
application.register({ | ||
id: 'my-app', | ||
title: 'My App', | ||
updater$: this.appUpdater, | ||
async mount(params) { | ||
const { renderApp } = await import('./application'); | ||
return renderApp(params); | ||
}, | ||
}); | ||
} | ||
|
||
start() { | ||
// later, when the navlink needs to be updated | ||
appUpdater.next(() => { | ||
navLinkStatus: AppNavLinkStatus.disabled, | ||
}) | ||
} | ||
|
||
``` | ||
15 changes: 15 additions & 0 deletions
15
docs/development/core/public/kibana-plugin-public.appleaveaction.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,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppLeaveAction](./kibana-plugin-public.appleaveaction.md) | ||
|
||
## AppLeaveAction type | ||
|
||
Possible actions to return from a [AppLeaveHandler](./kibana-plugin-public.appleavehandler.md) | ||
|
||
See [AppLeaveConfirmAction](./kibana-plugin-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-public.appleavedefaultaction.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/public/kibana-plugin-public.appleaveactiontype.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) > [AppLeaveActionType](./kibana-plugin-public.appleaveactiontype.md) | ||
|
||
## AppLeaveActionType enum | ||
|
||
Possible type of actions on application leave. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare enum AppLeaveActionType | ||
``` | ||
|
||
## Enumeration Members | ||
|
||
| Member | Value | Description | | ||
| --- | --- | --- | | ||
| confirm | <code>"confirm"</code> | | | ||
| default | <code>"default"</code> | | | ||
|
24 changes: 24 additions & 0 deletions
24
docs/development/core/public/kibana-plugin-public.appleaveconfirmaction.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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppLeaveConfirmAction](./kibana-plugin-public.appleaveconfirmaction.md) | ||
|
||
## AppLeaveConfirmAction interface | ||
|
||
Action to return from a [AppLeaveHandler](./kibana-plugin-public.appleavehandler.md) to show a confirmation message when trying to leave an application. | ||
|
||
See | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface AppLeaveConfirmAction | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [text](./kibana-plugin-public.appleaveconfirmaction.text.md) | <code>string</code> | | | ||
| [title](./kibana-plugin-public.appleaveconfirmaction.title.md) | <code>string</code> | | | ||
| [type](./kibana-plugin-public.appleaveconfirmaction.type.md) | <code>AppLeaveActionType.confirm</code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.appleaveconfirmaction.text.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) > [AppLeaveConfirmAction](./kibana-plugin-public.appleaveconfirmaction.md) > [text](./kibana-plugin-public.appleaveconfirmaction.text.md) | ||
|
||
## AppLeaveConfirmAction.text property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
text: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.appleaveconfirmaction.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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppLeaveConfirmAction](./kibana-plugin-public.appleaveconfirmaction.md) > [title](./kibana-plugin-public.appleaveconfirmaction.title.md) | ||
|
||
## AppLeaveConfirmAction.title property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
title?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.appleaveconfirmaction.type.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) > [AppLeaveConfirmAction](./kibana-plugin-public.appleaveconfirmaction.md) > [type](./kibana-plugin-public.appleaveconfirmaction.type.md) | ||
|
||
## AppLeaveConfirmAction.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: AppLeaveActionType.confirm; | ||
``` |
22 changes: 22 additions & 0 deletions
22
docs/development/core/public/kibana-plugin-public.appleavedefaultaction.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,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppLeaveDefaultAction](./kibana-plugin-public.appleavedefaultaction.md) | ||
|
||
## AppLeaveDefaultAction interface | ||
|
||
Action to return from a [AppLeaveHandler](./kibana-plugin-public.appleavehandler.md) to execute the default behaviour when leaving the application. | ||
|
||
See | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface AppLeaveDefaultAction | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [type](./kibana-plugin-public.appleavedefaultaction.type.md) | <code>AppLeaveActionType.default</code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.appleavedefaultaction.type.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) > [AppLeaveDefaultAction](./kibana-plugin-public.appleavedefaultaction.md) > [type](./kibana-plugin-public.appleavedefaultaction.type.md) | ||
|
||
## AppLeaveDefaultAction.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: AppLeaveActionType.default; | ||
``` |
15 changes: 15 additions & 0 deletions
15
docs/development/core/public/kibana-plugin-public.appleavehandler.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,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppLeaveHandler](./kibana-plugin-public.appleavehandler.md) | ||
|
||
## AppLeaveHandler type | ||
|
||
A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return `confirm` to to prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing). | ||
|
||
See [AppMountParameters](./kibana-plugin-public.appmountparameters.md) for detailed usage examples. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type AppLeaveHandler = (factory: AppLeaveActionFactory) => AppLeaveAction; | ||
``` |
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
47 changes: 47 additions & 0 deletions
47
...lopment/core/public/kibana-plugin-public.applicationsetup.registerappupdater.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,47 @@ | ||
<!-- 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) > [registerAppUpdater](./kibana-plugin-public.applicationsetup.registerappupdater.md) | ||
|
||
## ApplicationSetup.registerAppUpdater() method | ||
|
||
Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) fields of all applications at runtime. | ||
|
||
This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the `updater$` property of the registered application instead. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
registerAppUpdater(appUpdater$: Observable<AppUpdater>): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| appUpdater$ | <code>Observable<AppUpdater></code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
||
## Example | ||
|
||
How to register an application updater that disables some applications: | ||
|
||
```ts | ||
// inside your plugin's setup function | ||
export class MyPlugin implements Plugin { | ||
setup({ application }) { | ||
application.registerAppUpdater( | ||
new BehaviorSubject<AppUpdater>(app => { | ||
if (myPluginApi.shouldDisable(app)) | ||
return { | ||
status: AppStatus.inaccessible, | ||
}; | ||
}) | ||
); | ||
} | ||
} | ||
|
||
``` | ||
|
Oops, something went wrong.