-
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 bugfix/ILM
- Loading branch information
Showing
234 changed files
with
9,198 additions
and
3,240 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
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
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
41 changes: 41 additions & 0 deletions
41
docs/development/core/public/kibana-plugin-public.appmountparameters.onappleave.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,41 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [AppMountParameters](./kibana-plugin-public.appmountparameters.md) > [onAppLeave](./kibana-plugin-public.appmountparameters.onappleave.md) | ||
|
||
## AppMountParameters.onAppLeave property | ||
|
||
A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page. | ||
|
||
This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
onAppLeave: (handler: AppLeaveHandler) => void; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
// application.tsx | ||
import React from 'react'; | ||
import ReactDOM from 'react-dom'; | ||
import { BrowserRouter, Route } from 'react-router-dom'; | ||
|
||
import { CoreStart, AppMountParams } from 'src/core/public'; | ||
import { MyPluginDepsStart } from './plugin'; | ||
|
||
export renderApp = ({ appBasePath, element, onAppLeave }: AppMountParams) => { | ||
const { renderApp, hasUnsavedChanges } = await import('./application'); | ||
onAppLeave(actions => { | ||
if(hasUnsavedChanges()) { | ||
return actions.confirm('Some changes were not saved. Are you sure you want to leave?'); | ||
} | ||
return actions.default(); | ||
}); | ||
return renderApp(params); | ||
} | ||
|
||
``` | ||
|
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
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
12 changes: 12 additions & 0 deletions
12
docs/development/core/public/kibana-plugin-public.overlaystart.openconfirm.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,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayStart](./kibana-plugin-public.overlaystart.md) > [openConfirm](./kibana-plugin-public.overlaystart.openconfirm.md) | ||
|
||
## OverlayStart.openConfirm property | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
openConfirm: OverlayModalStart['openConfirm']; | ||
``` |
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
Oops, something went wrong.