mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
Remove old doc generation system for core APIs (#134313)
* Remove old doc generation system for core APIs * delete docs/development/core folder
This commit is contained in:
Pierre Gayvallet
GitHub
parent
7439c2bba9
commit
10a5f9ac83
1720 changed files with 0 additions and 30484 deletions
|
|
@ -11,7 +11,6 @@ export DISABLE_BOOTSTRAP_VALIDATION=false
|
|||
.buildkite/scripts/steps/checks/telemetry.sh
|
||||
.buildkite/scripts/steps/checks/ts_projects.sh
|
||||
.buildkite/scripts/steps/checks/jest_configs.sh
|
||||
.buildkite/scripts/steps/checks/doc_api_changes.sh
|
||||
.buildkite/scripts/steps/checks/kbn_pm_dist.sh
|
||||
.buildkite/scripts/steps/checks/plugin_list_docs.sh
|
||||
.buildkite/scripts/steps/checks/bundle_limits.sh
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
source .buildkite/scripts/common/util.sh
|
||||
|
||||
echo --- Check Doc API Changes
|
||||
checks-reporter-with-killswitch "Check Doc API Changes" \
|
||||
node scripts/check_published_api_changes
|
||||
1
.github/CODEOWNERS
vendored
1
.github/CODEOWNERS
vendored
|
|
@ -291,7 +291,6 @@
|
|||
/packages/kbn-logging-mocks/ @elastic/kibana-core
|
||||
/packages/kbn-http-tools/ @elastic/kibana-core
|
||||
/src/plugins/saved_objects_management/ @elastic/kibana-core
|
||||
/src/dev/run_check_published_api_changes.ts @elastic/kibana-core
|
||||
/src/plugins/advanced_settings/ @elastic/kibana-core
|
||||
/x-pack/plugins/global_search_bar/ @elastic/kibana-core
|
||||
/test/analytics @elastic/kibana-core
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md)
|
||||
|
||||
## API Reference
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Description |
|
||||
| --- | --- |
|
||||
| [kibana-plugin-core-public](./kibana-plugin-core-public.md) | The Kibana Core APIs for client-side plugins.<!-- -->A plugin's <code>public/index</code> file must contain a named import, <code>plugin</code>, that implements which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [appRoute](./kibana-plugin-core-public.app.approute.md)
|
||||
|
||||
## App.appRoute property
|
||||
|
||||
Override the application's routing path from `/app/${id}`<!-- -->. Must be unique across registered applications. Should not include the base path from HTTP.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
appRoute?: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [capabilities](./kibana-plugin-core-public.app.capabilities.md)
|
||||
|
||||
## App.capabilities property
|
||||
|
||||
Custom capabilities defined by the app.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
capabilities?: Partial<Capabilities>;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [category](./kibana-plugin-core-public.app.category.md)
|
||||
|
||||
## App.category property
|
||||
|
||||
The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
category?: AppCategory;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [chromeless](./kibana-plugin-core-public.app.chromeless.md)
|
||||
|
||||
## App.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;
|
||||
```
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [deepLinks](./kibana-plugin-core-public.app.deeplinks.md)
|
||||
|
||||
## App.deepLinks property
|
||||
|
||||
Input type for registering secondary in-app locations for an application.
|
||||
|
||||
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
deepLinks?: AppDeepLink[];
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```ts
|
||||
core.application.register({
|
||||
id: 'my_app',
|
||||
title: 'Translated title',
|
||||
keywords: ['translated keyword1', 'translated keyword2'],
|
||||
deepLinks: [
|
||||
{
|
||||
id: 'sub1',
|
||||
title: 'Sub1',
|
||||
path: '/sub1',
|
||||
keywords: ['subpath1'],
|
||||
},
|
||||
{
|
||||
id: 'sub2',
|
||||
title: 'Sub2',
|
||||
deepLinks: [
|
||||
{
|
||||
id: 'subsub',
|
||||
title: 'SubSub',
|
||||
path: '/sub2/sub',
|
||||
keywords: ['subpath2'],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
mount: () => { ... }
|
||||
})
|
||||
```
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [defaultPath](./kibana-plugin-core-public.app.defaultpath.md)
|
||||
|
||||
## App.defaultPath property
|
||||
|
||||
Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the `path` option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
defaultPath?: string;
|
||||
```
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [exactRoute](./kibana-plugin-core-public.app.exactroute.md)
|
||||
|
||||
## App.exactRoute property
|
||||
|
||||
If set to true, the application's route will only be checked against an exact match. Defaults to `false`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
exactRoute?: boolean;
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```ts
|
||||
core.application.register({
|
||||
id: 'my_app',
|
||||
title: 'My App',
|
||||
exactRoute: true,
|
||||
mount: () => { ... },
|
||||
})
|
||||
|
||||
// '[basePath]/app/my_app' will be matched
|
||||
// '[basePath]/app/my_app/some/path' will not be matched
|
||||
```
|
||||
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [id](./kibana-plugin-core-public.app.id.md)
|
||||
|
||||
## App.id property
|
||||
|
||||
The unique identifier of the application.
|
||||
|
||||
Can only be composed of alphanumeric characters, `-`<!-- -->, `:` and `_`
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [keywords](./kibana-plugin-core-public.app.keywords.md)
|
||||
|
||||
## App.keywords property
|
||||
|
||||
Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
keywords?: string[];
|
||||
```
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md)
|
||||
|
||||
## App interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface App<HistoryLocationState = unknown> extends AppNavOptions
|
||||
```
|
||||
<b>Extends:</b> AppNavOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [appRoute?](./kibana-plugin-core-public.app.approute.md) | string | <i>(Optional)</i> Override the application's routing path from <code>/app/${id}</code>. Must be unique across registered applications. Should not include the base path from HTTP. |
|
||||
| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | Partial<Capabilities> | <i>(Optional)</i> Custom capabilities defined by the app. |
|
||||
| [category?](./kibana-plugin-core-public.app.category.md) | AppCategory | <i>(Optional)</i> The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
|
||||
| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | boolean | <i>(Optional)</i> Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
|
||||
| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | AppDeepLink\[\] | <i>(Optional)</i> Input type for registering secondary in-app locations for an application.<!-- -->Deep links must include at least one of <code>path</code> or <code>deepLinks</code>. A deep link that does not have a <code>path</code> represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
|
||||
| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | string | <i>(Optional)</i> Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the <code>path</code> option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
|
||||
| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | boolean | <i>(Optional)</i> If set to true, the application's route will only be checked against an exact match. Defaults to <code>false</code>. |
|
||||
| [id](./kibana-plugin-core-public.app.id.md) | string | The unique identifier of the application.<!-- -->Can only be composed of alphanumeric characters, <code>-</code>, <code>:</code> and <code>_</code> |
|
||||
| [keywords?](./kibana-plugin-core-public.app.keywords.md) | string\[\] | <i>(Optional)</i> Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. |
|
||||
| [mount](./kibana-plugin-core-public.app.mount.md) | AppMount<HistoryLocationState> | A mount function called when the user navigates to this app's route. |
|
||||
| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | AppNavLinkStatus | <i>(Optional)</i> The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
|
||||
| [searchable?](./kibana-plugin-core-public.app.searchable.md) | boolean | <i>(Optional)</i> The initial flag to determine if the application is searchable in the global search. Defaulting to <code>true</code> if <code>navLinkStatus</code> is <code>visible</code> or omitted. |
|
||||
| [status?](./kibana-plugin-core-public.app.status.md) | AppStatus | <i>(Optional)</i> The initial status of the application. Defaulting to <code>accessible</code> |
|
||||
| [title](./kibana-plugin-core-public.app.title.md) | string | The title of the application. |
|
||||
| [updater$?](./kibana-plugin-core-public.app.updater_.md) | Observable<AppUpdater> | <i>(Optional)</i> An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [mount](./kibana-plugin-core-public.app.mount.md)
|
||||
|
||||
## App.mount property
|
||||
|
||||
A mount function called when the user navigates to this app's route.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
mount: AppMount<HistoryLocationState>;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md)
|
||||
|
||||
## App.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-core-public.appnavlinkstatus.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
navLinkStatus?: AppNavLinkStatus;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [searchable](./kibana-plugin-core-public.app.searchable.md)
|
||||
|
||||
## App.searchable property
|
||||
|
||||
The initial flag to determine if the application is searchable in the global search. Defaulting to `true` if `navLinkStatus` is `visible` or omitted.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
searchable?: boolean;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [status](./kibana-plugin-core-public.app.status.md)
|
||||
|
||||
## App.status property
|
||||
|
||||
The initial status of the application. Defaulting to `accessible`
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
status?: AppStatus;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [title](./kibana-plugin-core-public.app.title.md)
|
||||
|
||||
## App.title property
|
||||
|
||||
The title of the application.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
title: string;
|
||||
```
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [updater$](./kibana-plugin-core-public.app.updater_.md)
|
||||
|
||||
## App.updater$ property
|
||||
|
||||
An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-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,
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [APP\_WRAPPER\_CLASS](./kibana-plugin-core-public.app_wrapper_class.md)
|
||||
|
||||
## APP\_WRAPPER\_CLASS variable
|
||||
|
||||
The class name for top level \*and\* nested application wrappers to ensure proper layout
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
APP_WRAPPER_CLASS = "kbnAppWrapper"
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [ariaLabel](./kibana-plugin-core-public.appcategory.arialabel.md)
|
||||
|
||||
## AppCategory.ariaLabel property
|
||||
|
||||
If the visual label isn't appropriate for screen readers, can override it here
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ariaLabel?: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [euiIconType](./kibana-plugin-core-public.appcategory.euiicontype.md)
|
||||
|
||||
## AppCategory.euiIconType property
|
||||
|
||||
Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
euiIconType?: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [id](./kibana-plugin-core-public.appcategory.id.md)
|
||||
|
||||
## AppCategory.id property
|
||||
|
||||
Unique identifier for the categories
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [label](./kibana-plugin-core-public.appcategory.label.md)
|
||||
|
||||
## AppCategory.label property
|
||||
|
||||
Label used for category name. Also used as aria-label if one isn't set.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
label: string;
|
||||
```
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md)
|
||||
|
||||
## AppCategory interface
|
||||
|
||||
A category definition for nav links to know where to sort them in the left hand nav
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AppCategory
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [ariaLabel?](./kibana-plugin-core-public.appcategory.arialabel.md) | string | <i>(Optional)</i> If the visual label isn't appropriate for screen readers, can override it here |
|
||||
| [euiIconType?](./kibana-plugin-core-public.appcategory.euiicontype.md) | string | <i>(Optional)</i> Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined |
|
||||
| [id](./kibana-plugin-core-public.appcategory.id.md) | string | Unique identifier for the categories |
|
||||
| [label](./kibana-plugin-core-public.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. |
|
||||
| [order?](./kibana-plugin-core-public.appcategory.order.md) | number | <i>(Optional)</i> The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [order](./kibana-plugin-core-public.appcategory.order.md)
|
||||
|
||||
## AppCategory.order property
|
||||
|
||||
The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
order?: number;
|
||||
```
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md)
|
||||
|
||||
## AppDeepLink type
|
||||
|
||||
Input type for registering secondary in-app locations for an application.
|
||||
|
||||
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppDeepLink = {
|
||||
id: string;
|
||||
title: string;
|
||||
keywords?: string[];
|
||||
navLinkStatus?: AppNavLinkStatus;
|
||||
searchable?: boolean;
|
||||
} & AppNavOptions & ({
|
||||
path: string;
|
||||
deepLinks?: AppDeepLink[];
|
||||
} | {
|
||||
path?: string;
|
||||
deepLinks: AppDeepLink[];
|
||||
});
|
||||
```
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md)
|
||||
|
||||
## AppLeaveAction type
|
||||
|
||||
Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)
|
||||
|
||||
See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction;
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveActionType](./kibana-plugin-core-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> | |
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [buttonColor](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md)
|
||||
|
||||
## AppLeaveConfirmAction.buttonColor property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
buttonColor?: ButtonColor;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [callback](./kibana-plugin-core-public.appleaveconfirmaction.callback.md)
|
||||
|
||||
## AppLeaveConfirmAction.callback property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
callback?: () => void;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [confirmButtonText](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md)
|
||||
|
||||
## AppLeaveConfirmAction.confirmButtonText property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
confirmButtonText?: string;
|
||||
```
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md)
|
||||
|
||||
## AppLeaveConfirmAction interface
|
||||
|
||||
Action to return from a [AppLeaveHandler](./kibana-plugin-core-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 |
|
||||
| --- | --- | --- |
|
||||
| [buttonColor?](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md) | ButtonColor | <i>(Optional)</i> |
|
||||
| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | () => void | <i>(Optional)</i> |
|
||||
| [confirmButtonText?](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md) | string | <i>(Optional)</i> |
|
||||
| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | string | |
|
||||
| [title?](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | string | <i>(Optional)</i> |
|
||||
| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | AppLeaveActionType.confirm | |
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md)
|
||||
|
||||
## AppLeaveConfirmAction.text property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [title](./kibana-plugin-core-public.appleaveconfirmaction.title.md)
|
||||
|
||||
## AppLeaveConfirmAction.title property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md)
|
||||
|
||||
## AppLeaveConfirmAction.type property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type: AppLeaveActionType.confirm;
|
||||
```
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md)
|
||||
|
||||
## AppLeaveDefaultAction interface
|
||||
|
||||
Action to return from a [AppLeaveHandler](./kibana-plugin-core-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-core-public.appleavedefaultaction.type.md) | AppLeaveActionType.default | |
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) > [type](./kibana-plugin-core-public.appleavedefaultaction.type.md)
|
||||
|
||||
## AppLeaveDefaultAction.type property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type: AppLeaveActionType.default;
|
||||
```
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)
|
||||
|
||||
## AppLeaveHandler type
|
||||
|
||||
> Warning: This API is now obsolete.
|
||||
>
|
||||
> [AppMountParameters.onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) has been deprecated in favor of [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) 8.8.0
|
||||
>
|
||||
|
||||
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 prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing).
|
||||
|
||||
See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppLeaveHandler = (factory: AppLeaveActionFactory, nextAppId?: string) => AppLeaveAction;
|
||||
```
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md)
|
||||
|
||||
## ApplicationSetup interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ApplicationSetup
|
||||
```
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [register(app)](./kibana-plugin-core-public.applicationsetup.register.md) | Register an mountable application to the system. |
|
||||
| [registerAppUpdater(appUpdater$)](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) | Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-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 <code>updater$</code> property of the registered application instead. |
|
||||
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [register](./kibana-plugin-core-public.applicationsetup.register.md)
|
||||
|
||||
## ApplicationSetup.register() method
|
||||
|
||||
Register an mountable application to the system.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
register<HistoryLocationState = unknown>(app: App<HistoryLocationState>): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| app | App<HistoryLocationState> | an [App](./kibana-plugin-core-public.app.md) |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
void
|
||||
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [registerAppUpdater](./kibana-plugin-core-public.applicationsetup.registerappupdater.md)
|
||||
|
||||
## ApplicationSetup.registerAppUpdater() method
|
||||
|
||||
Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-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$ | Observable<AppUpdater> | |
|
||||
|
||||
<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,
|
||||
};
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [applications$](./kibana-plugin-core-public.applicationstart.applications_.md)
|
||||
|
||||
## ApplicationStart.applications$ property
|
||||
|
||||
Observable emitting the list of currently registered apps and their associated status.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
applications$: Observable<ReadonlyMap<string, PublicAppInfo>>;
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
Applications disabled by [Capabilities](./kibana-plugin-core-public.capabilities.md) will not be present in the map. Applications manually disabled from the client-side using an [application updater](./kibana-plugin-core-public.appupdater.md) are present, with their status properly set as `inaccessible`<!-- -->.
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md)
|
||||
|
||||
## ApplicationStart.capabilities property
|
||||
|
||||
Gets the read-only capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
capabilities: RecursiveReadonly<Capabilities>;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md)
|
||||
|
||||
## ApplicationStart.currentAppId$ property
|
||||
|
||||
An observable that emits the current application id and each subsequent id update.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
currentAppId$: Observable<string | undefined>;
|
||||
```
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [getUrlForApp](./kibana-plugin-core-public.applicationstart.geturlforapp.md)
|
||||
|
||||
## ApplicationStart.getUrlForApp() method
|
||||
|
||||
Returns the absolute path (or URL) to a given app, including the global base path.
|
||||
|
||||
By default, it returns the absolute path of the application (e.g `/basePath/app/my-app`<!-- -->). Use the `absolute` option to generate an absolute url instead (e.g `http://host:port/basePath/app/my-app`<!-- -->)
|
||||
|
||||
Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getUrlForApp(appId: string, options?: {
|
||||
path?: string;
|
||||
absolute?: boolean;
|
||||
deepLinkId?: string;
|
||||
}): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| appId | string | |
|
||||
| options | { path?: string; absolute?: boolean; deepLinkId?: string; } | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md)
|
||||
|
||||
## ApplicationStart interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ApplicationStart
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) | Observable<ReadonlyMap<string, PublicAppInfo>> | Observable emitting the list of currently registered apps and their associated status. |
|
||||
| [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) | RecursiveReadonly<Capabilities> | Gets the read-only capabilities. |
|
||||
| [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) | Observable<string \| undefined> | An observable that emits the current application id and each subsequent id update. |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getUrlForApp(appId, options)](./kibana-plugin-core-public.applicationstart.geturlforapp.md) | Returns the absolute path (or URL) to a given app, including the global base path.<!-- -->By default, it returns the absolute path of the application (e.g <code>/basePath/app/my-app</code>). Use the <code>absolute</code> option to generate an absolute url instead (e.g <code>http://host:port/basePath/app/my-app</code>)<!-- -->Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. |
|
||||
| [navigateToApp(appId, options)](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | Navigate to a given app |
|
||||
| [navigateToUrl(url, options)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).<!-- -->The method resolves pathnames the same way browsers do when resolving a <code><a href></code> value. The provided <code>url</code> can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)<!-- -->If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app/<id>/ or any application's <code>appRoute</code> configuration)<!-- -->Then a SPA navigation will be performed using <code>navigateToApp</code> using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using <code>window.location.assign</code>. |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)
|
||||
|
||||
## ApplicationStart.navigateToApp() method
|
||||
|
||||
Navigate to a given app
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
navigateToApp(appId: string, options?: NavigateToAppOptions): Promise<void>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| appId | string | |
|
||||
| options | NavigateToAppOptions | navigation options |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
Promise<void>
|
||||
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToUrl](./kibana-plugin-core-public.applicationstart.navigatetourl.md)
|
||||
|
||||
## ApplicationStart.navigateToUrl() method
|
||||
|
||||
Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).
|
||||
|
||||
The method resolves pathnames the same way browsers do when resolving a `<a href>` value. The provided `url` can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)
|
||||
|
||||
If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app/<id>/ or any application's `appRoute` configuration)
|
||||
|
||||
Then a SPA navigation will be performed using `navigateToApp` using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using `window.location.assign`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
navigateToUrl(url: string, options?: NavigateToUrlOptions): Promise<void>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | string | an absolute URL, an absolute path or a relative path, to navigate to. |
|
||||
| options | NavigateToUrlOptions | navigation options |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
Promise<void>
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```ts
|
||||
// current url: `https://kibana:8080/base-path/s/my-space/app/dashboard`
|
||||
|
||||
// will call `application.navigateToApp('discover', { path: '/some-path?foo=bar'})`
|
||||
application.navigateToUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar')
|
||||
application.navigateToUrl('/base-path/s/my-space/app/discover/some-path?foo=bar')
|
||||
application.navigateToUrl('./discover/some-path?foo=bar')
|
||||
|
||||
// will perform a full page reload using `window.location.assign`
|
||||
application.navigateToUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match
|
||||
application.navigateToUrl('/app/discover/some-path') // does not include the current basePath
|
||||
application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application
|
||||
application.navigateToUrl('../discover') // resolve to `/base-path/s/my-space/discover` which is not a path of a known app.
|
||||
application.navigateToUrl('../../other-space/discover') // resolve to `/base-path/s/other-space/discover` which is not within the current basePath.
|
||||
```
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMount](./kibana-plugin-core-public.appmount.md)
|
||||
|
||||
## AppMount type
|
||||
|
||||
A mount function called when the user navigates to this app's route.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppMount<HistoryLocationState = unknown> = (params: AppMountParameters<HistoryLocationState>) => AppUnmount | Promise<AppUnmount>;
|
||||
```
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md)
|
||||
|
||||
## AppMountParameters.appBasePath property
|
||||
|
||||
> Warning: This API is now obsolete.
|
||||
>
|
||||
> Use [AppMountParameters.history](./kibana-plugin-core-public.appmountparameters.history.md) instead. 8.8.0
|
||||
>
|
||||
|
||||
The route path for configuring navigation to the application. This string should not include the base path from HTTP.
|
||||
|
||||
<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',
|
||||
appRoute: '/my-app',
|
||||
async mount(params) {
|
||||
const { renderApp } = await import('./application');
|
||||
return renderApp(params);
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```ts
|
||||
// application.tsx
|
||||
import React from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
import { BrowserRouter, Route } from 'react-router-dom';
|
||||
|
||||
import { CoreStart, AppMountParameters } from 'src/core/public';
|
||||
import { MyPluginDepsStart } from './plugin';
|
||||
|
||||
export renderApp = ({ appBasePath, element }: AppMountParameters) => {
|
||||
ReactDOM.render(
|
||||
// pass `appBasePath` to `basename`
|
||||
<BrowserRouter basename={appBasePath}>
|
||||
<Route path="/" exact component={HomePage} />
|
||||
</BrowserRouter>,
|
||||
element
|
||||
);
|
||||
|
||||
return () => ReactDOM.unmountComponentAtNode(element);
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [element](./kibana-plugin-core-public.appmountparameters.element.md)
|
||||
|
||||
## AppMountParameters.element property
|
||||
|
||||
The container element to render the application into.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
element: HTMLElement;
|
||||
```
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [history](./kibana-plugin-core-public.appmountparameters.history.md)
|
||||
|
||||
## AppMountParameters.history property
|
||||
|
||||
A scoped history instance for your application. Should be used to wire up your applications Router.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
history: ScopedHistory<HistoryLocationState>;
|
||||
```
|
||||
|
||||
## 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',
|
||||
appRoute: '/my-app',
|
||||
async mount(params) {
|
||||
const { renderApp } = await import('./application');
|
||||
return renderApp(params);
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```ts
|
||||
// application.tsx
|
||||
import React from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
import { Router, Route } from 'react-router-dom';
|
||||
|
||||
import { CoreStart, AppMountParameters } from 'src/core/public';
|
||||
import { MyPluginDepsStart } from './plugin';
|
||||
|
||||
export renderApp = ({ element, history }: AppMountParameters) => {
|
||||
ReactDOM.render(
|
||||
<Router history={history}>
|
||||
<Route path="/" exact component={HomePage} />
|
||||
</Router>,
|
||||
element
|
||||
);
|
||||
|
||||
return () => ReactDOM.unmountComponentAtNode(element);
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md)
|
||||
|
||||
## AppMountParameters interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AppMountParameters<HistoryLocationState = unknown>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | string | The route path for configuring navigation to the application. This string should not include the base path from HTTP. |
|
||||
| [element](./kibana-plugin-core-public.appmountparameters.element.md) | HTMLElement | The container element to render the application into. |
|
||||
| [history](./kibana-plugin-core-public.appmountparameters.history.md) | ScopedHistory<HistoryLocationState> | A scoped history instance for your application. Should be used to wire up your applications Router. |
|
||||
| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | (handler: AppLeaveHandler) => void | 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. |
|
||||
| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | (menuMount: MountPoint \| undefined) => void | A function that can be used to set the mount point used to populate the application action container in the chrome header.<!-- -->Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with <code>undefined</code> will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. |
|
||||
| [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md) | Observable<CoreTheme> | An observable emitting . Should be used when mounting the application to include theme information. |
|
||||
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md)
|
||||
|
||||
## AppMountParameters.onAppLeave property
|
||||
|
||||
> Warning: This API is now obsolete.
|
||||
>
|
||||
> [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) should be used instead. 8.8.0
|
||||
>
|
||||
|
||||
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, AppMountParameters } from 'src/core/public';
|
||||
import { MyPluginDepsStart } from './plugin';
|
||||
|
||||
export renderApp = ({ element, history, onAppLeave }: AppMountParameters) => {
|
||||
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({ element, history });
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md)
|
||||
|
||||
## AppMountParameters.setHeaderActionMenu property
|
||||
|
||||
A function that can be used to set the mount point used to populate the application action container in the chrome header.
|
||||
|
||||
Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with `undefined` will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setHeaderActionMenu: (menuMount: MountPoint | undefined) => void;
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```ts
|
||||
// application.tsx
|
||||
import React from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
import { BrowserRouter, Route } from 'react-router-dom';
|
||||
|
||||
import { CoreStart, AppMountParameters } from 'src/core/public';
|
||||
import { MyPluginDepsStart } from './plugin';
|
||||
|
||||
export renderApp = ({ element, history, setHeaderActionMenu }: AppMountParameters) => {
|
||||
const { renderApp } = await import('./application');
|
||||
const { renderActionMenu } = await import('./action_menu');
|
||||
setHeaderActionMenu((element) => {
|
||||
return renderActionMenu(element);
|
||||
})
|
||||
return renderApp({ element, history });
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md)
|
||||
|
||||
## AppMountParameters.theme$ property
|
||||
|
||||
An observable emitting . Should be used when mounting the application to include theme information.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
theme$: Observable<CoreTheme>;
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
When mounting a react application:
|
||||
|
||||
```ts
|
||||
// application.tsx
|
||||
import React from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
|
||||
import { AppMountParameters } from 'src/core/public';
|
||||
import { wrapWithTheme } from 'src/plugins/kibana_react';
|
||||
import { MyApp } from './app';
|
||||
|
||||
export renderApp = ({ element, theme$ }: AppMountParameters) => {
|
||||
ReactDOM.render(wrapWithTheme(<MyApp/>, theme$), element);
|
||||
return () => ReactDOM.unmountComponentAtNode(element);
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md)
|
||||
|
||||
## AppNavLinkStatus enum
|
||||
|
||||
Status of the application's navLink.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum AppNavLinkStatus
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| default | <code>0</code> | The application navLink will be <code>visible</code> if the application's [AppStatus](./kibana-plugin-core-public.appstatus.md) is set to <code>accessible</code> and <code>hidden</code> if the application status is set to <code>inaccessible</code>. |
|
||||
| disabled | <code>2</code> | The application navLink is visible but inactive and not clickable in the navigation bar. |
|
||||
| hidden | <code>3</code> | The application navLink does not appear in the navigation bar. |
|
||||
| visible | <code>1</code> | The application navLink is visible and clickable in the navigation bar. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [euiIconType](./kibana-plugin-core-public.appnavoptions.euiicontype.md)
|
||||
|
||||
## AppNavOptions.euiIconType property
|
||||
|
||||
A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
euiIconType?: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [icon](./kibana-plugin-core-public.appnavoptions.icon.md)
|
||||
|
||||
## AppNavOptions.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;
|
||||
```
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md)
|
||||
|
||||
## AppNavOptions interface
|
||||
|
||||
App navigation menu options
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AppNavOptions
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [euiIconType?](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | string | <i>(Optional)</i> A EUI iconType that will be used for the app's icon. This icon takes precedence over the <code>icon</code> property. |
|
||||
| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | string | <i>(Optional)</i> A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
|
||||
| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | number | <i>(Optional)</i> An ordinal used to sort nav links relative to one another for display. |
|
||||
| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | string | <i>(Optional)</i> A tooltip shown when hovering over app link. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [order](./kibana-plugin-core-public.appnavoptions.order.md)
|
||||
|
||||
## AppNavOptions.order property
|
||||
|
||||
An ordinal used to sort nav links relative to one another for display.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
order?: number;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [tooltip](./kibana-plugin-core-public.appnavoptions.tooltip.md)
|
||||
|
||||
## AppNavOptions.tooltip property
|
||||
|
||||
A tooltip shown when hovering over app link.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
tooltip?: string;
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppStatus](./kibana-plugin-core-public.appstatus.md)
|
||||
|
||||
## AppStatus enum
|
||||
|
||||
Accessibility status of an application.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum AppStatus
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| accessible | <code>0</code> | Application is accessible. |
|
||||
| inaccessible | <code>1</code> | Application is not accessible. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUnmount](./kibana-plugin-core-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;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md)
|
||||
|
||||
## AppUpdatableFields type
|
||||
|
||||
Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md)<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppUpdatableFields = Pick<App, 'status' | 'navLinkStatus' | 'searchable' | 'tooltip' | 'defaultPath' | 'deepLinks'>;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdater](./kibana-plugin-core-public.appupdater.md)
|
||||
|
||||
## AppUpdater type
|
||||
|
||||
Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type AppUpdater = (app: App) => Partial<AppUpdatableFields> | undefined;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md)
|
||||
|
||||
## Capabilities.catalogue property
|
||||
|
||||
Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
catalogue: Record<string, boolean>;
|
||||
```
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [management](./kibana-plugin-core-public.capabilities.management.md)
|
||||
|
||||
## Capabilities.management property
|
||||
|
||||
Management section capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
management: {
|
||||
[sectionId: string]: Record<string, boolean>;
|
||||
};
|
||||
```
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md)
|
||||
|
||||
## Capabilities interface
|
||||
|
||||
The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Capabilities
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) | Record<string, boolean> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. |
|
||||
| [management](./kibana-plugin-core-public.capabilities.management.md) | { \[sectionId: string\]: Record<string, boolean>; } | Management section capabilities. |
|
||||
| [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) | Record<string, boolean> | Navigation link capabilities. |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md)
|
||||
|
||||
## Capabilities.navLinks property
|
||||
|
||||
Navigation link capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
navLinks: Record<string, boolean>;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [iconType](./kibana-plugin-core-public.chromebadge.icontype.md)
|
||||
|
||||
## ChromeBadge.iconType property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
iconType?: IconType;
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md)
|
||||
|
||||
## ChromeBadge interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeBadge
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [iconType?](./kibana-plugin-core-public.chromebadge.icontype.md) | IconType | <i>(Optional)</i> |
|
||||
| [text](./kibana-plugin-core-public.chromebadge.text.md) | string | |
|
||||
| [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) | string | |
|
||||
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [text](./kibana-plugin-core-public.chromebadge.text.md)
|
||||
|
||||
## ChromeBadge.text property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md)
|
||||
|
||||
## ChromeBadge.tooltip property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
tooltip: string;
|
||||
```
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md)
|
||||
|
||||
## ChromeBreadcrumb type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type ChromeBreadcrumb = EuiBreadcrumb;
|
||||
```
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [change](./kibana-plugin-core-public.chromedoctitle.change.md)
|
||||
|
||||
## ChromeDocTitle.change() method
|
||||
|
||||
Changes the current document title.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
change(newTitle: string | string[]): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| newTitle | string \| string\[\] | The new title to set, either a string or string array |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
void
|
||||
|
||||
## Example
|
||||
|
||||
How to change the title of the document
|
||||
|
||||
```ts
|
||||
chrome.docTitle.change('My application title')
|
||||
chrome.docTitle.change(['My application', 'My section'])
|
||||
```
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md)
|
||||
|
||||
## ChromeDocTitle interface
|
||||
|
||||
APIs for accessing and updating the document title.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeDocTitle
|
||||
```
|
||||
|
||||
## Example 1
|
||||
|
||||
How to change the title of the document
|
||||
|
||||
```ts
|
||||
chrome.docTitle.change('My application')
|
||||
```
|
||||
|
||||
## Example 2
|
||||
|
||||
How to reset the title of the document to it's initial value
|
||||
|
||||
```ts
|
||||
chrome.docTitle.reset()
|
||||
```
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [change(newTitle)](./kibana-plugin-core-public.chromedoctitle.change.md) | Changes the current document title. |
|
||||
| [reset()](./kibana-plugin-core-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) |
|
||||
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [reset](./kibana-plugin-core-public.chromedoctitle.reset.md)
|
||||
|
||||
## ChromeDocTitle.reset() method
|
||||
|
||||
Resets the document title to it's initial value. (meaning the one present in the title meta at application load.)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
reset(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
void
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [appName](./kibana-plugin-core-public.chromehelpextension.appname.md)
|
||||
|
||||
## ChromeHelpExtension.appName property
|
||||
|
||||
Provide your plugin's name to create a header for separation
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
appName: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [content](./kibana-plugin-core-public.chromehelpextension.content.md)
|
||||
|
||||
## ChromeHelpExtension.content property
|
||||
|
||||
Custom content to occur below the list of links
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
content?: (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [links](./kibana-plugin-core-public.chromehelpextension.links.md)
|
||||
|
||||
## ChromeHelpExtension.links property
|
||||
|
||||
Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
links?: ChromeHelpExtensionMenuLink[];
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md)
|
||||
|
||||
## ChromeHelpExtension interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeHelpExtension
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) | string | Provide your plugin's name to create a header for separation |
|
||||
| [content?](./kibana-plugin-core-public.chromehelpextension.content.md) | (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void | <i>(Optional)</i> Custom content to occur below the list of links |
|
||||
| [links?](./kibana-plugin-core-public.chromehelpextension.links.md) | ChromeHelpExtensionMenuLink\[\] | <i>(Optional)</i> Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button |
|
||||
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md)
|
||||
|
||||
## ChromeHelpExtensionLinkBase type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type ChromeHelpExtensionLinkBase = Pick<EuiButtonEmptyProps, 'iconType' | 'target' | 'rel' | 'data-test-subj'>;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md)
|
||||
|
||||
## ChromeHelpExtensionMenuCustomLink.content property
|
||||
|
||||
Content of the button (in lieu of `children`<!-- -->)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
content: React.ReactNode;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md)
|
||||
|
||||
## ChromeHelpExtensionMenuCustomLink.href property
|
||||
|
||||
URL of the link
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
href: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md)
|
||||
|
||||
## ChromeHelpExtensionMenuCustomLink.linkType property
|
||||
|
||||
Extend EuiButtonEmpty to provide extra functionality
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
linkType: 'custom';
|
||||
```
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md)
|
||||
|
||||
## ChromeHelpExtensionMenuCustomLink interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeHelpExtensionMenuCustomLink extends ChromeHelpExtensionLinkBase
|
||||
```
|
||||
<b>Extends:</b> ChromeHelpExtensionLinkBase
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | React.ReactNode | Content of the button (in lieu of <code>children</code>) |
|
||||
| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | string | URL of the link |
|
||||
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | 'custom' | Extend EuiButtonEmpty to provide extra functionality |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDiscussLink.href property
|
||||
|
||||
URL to discuss page. i.e. `https://discuss.elastic.co/c/${appName}`
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
href: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDiscussLink.linkType property
|
||||
|
||||
Creates a generic give feedback link with comment icon
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
linkType: 'discuss';
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDiscussLink interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase
|
||||
```
|
||||
<b>Extends:</b> ChromeHelpExtensionLinkBase
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | string | URL to discuss page. i.e. <code>https://discuss.elastic.co/c/${appName}</code> |
|
||||
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | 'discuss' | Creates a generic give feedback link with comment icon |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDocumentationLink.href property
|
||||
|
||||
URL to documentation page. i.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`<!-- -->,
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
href: string;
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDocumentationLink.linkType property
|
||||
|
||||
Creates a deep-link to app-specific documentation
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
linkType: 'documentation';
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md)
|
||||
|
||||
## ChromeHelpExtensionMenuDocumentationLink interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase
|
||||
```
|
||||
<b>Extends:</b> ChromeHelpExtensionLinkBase
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | string | URL to documentation page. i.e. <code>${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html</code>, |
|
||||
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | 'documentation' | Creates a deep-link to app-specific documentation |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md)
|
||||
|
||||
## ChromeHelpExtensionMenuGitHubLink.labels property
|
||||
|
||||
Include at least one app-specific label to be applied to the new github issue
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
labels: string[];
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md)
|
||||
|
||||
## ChromeHelpExtensionMenuGitHubLink.linkType property
|
||||
|
||||
Creates a link to a new github issue in the Kibana repo
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
linkType: 'github';
|
||||
```
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md)
|
||||
|
||||
## ChromeHelpExtensionMenuGitHubLink interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase
|
||||
```
|
||||
<b>Extends:</b> ChromeHelpExtensionLinkBase
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | string\[\] | Include at least one app-specific label to be applied to the new github issue |
|
||||
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | 'github' | Creates a link to a new github issue in the Kibana repo |
|
||||
| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | string | <i>(Optional)</i> Provides initial text for the title of the issue |
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md)
|
||||
|
||||
## ChromeHelpExtensionMenuGitHubLink.title property
|
||||
|
||||
Provides initial text for the title of the issue
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md)
|
||||
|
||||
## ChromeHelpExtensionMenuLink type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type ChromeHelpExtensionMenuLink = ChromeHelpExtensionMenuGitHubLink | ChromeHelpExtensionMenuDiscussLink | ChromeHelpExtensionMenuDocumentationLink | ChromeHelpExtensionMenuCustomLink;
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue