Skip to content

Commit d550eb2

Browse files
elasticmachineelasticmachine
authored
Merge branch '7.x' into backport/7.x/pr-54230
2 parents fdd1749 + 5f52cf0 commit d550eb2

381 files changed

Lines changed: 17981 additions & 2406 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintrc.js‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,6 @@ module.exports = {
8282
'react-hooks/exhaustive-deps': 'off',
8383
},
8484
},
85-
{
86-
files: ['src/legacy/core_plugins/vis_type_markdown/**/*.{js,ts,tsx}'],
87-
rules: {
88-
'react-hooks/exhaustive-deps': 'off',
89-
},
90-
},
9185
{
9286
files: ['src/legacy/core_plugins/vis_type_table/**/*.{js,ts,tsx}'],
9387
rules: {
@@ -353,9 +347,8 @@ module.exports = {
353347
'src/fixtures/**/*.js', // TODO: this directory needs to be more obviously "public" (or go away)
354348
],
355349
settings: {
356-
// instructs import/no-extraneous-dependencies to treat modules
357-
// in plugins/ or ui/ namespace as "core modules" so they don't
358-
// trigger failures for not being listed in package.json
350+
// instructs import/no-extraneous-dependencies to treat certain modules
351+
// as core modules, even if they aren't listed in package.json
359352
'import/core-modules': [
360353
'plugins',
361354
'legacy/ui',

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [chromeless](./kibana-plugin-public.appbase.chromeless.md)
4+
5+
## AppBase.chromeless property
6+
7+
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
chromeless?: boolean;
13+
```

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## AppBase.id property
66

7+
The unique identifier of the application
8+
79
<b>Signature:</b>
810

911
```typescript

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@ export interface AppBase
1616
| Property | Type | Description |
1717
| --- | --- | --- |
1818
| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
19+
| [chromeless](./kibana-plugin-public.appbase.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
1920
| [euiIconType](./kibana-plugin-public.appbase.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
2021
| [icon](./kibana-plugin-public.appbase.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
21-
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | |
22+
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | The unique identifier of the application |
23+
| [navLinkStatus](./kibana-plugin-public.appbase.navlinkstatus.md) | <code>AppNavLinkStatus</code> | 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-public.appnavlinkstatus.md) |
2224
| [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
25+
| [status](./kibana-plugin-public.appbase.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> |
2326
| [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
24-
| [tooltip$](./kibana-plugin-public.appbase.tooltip_.md) | <code>Observable&lt;string&gt;</code> | An observable for a tooltip shown when hovering over app link. |
27+
| [tooltip](./kibana-plugin-public.appbase.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |
28+
| [updater$](./kibana-plugin-public.appbase.updater_.md) | <code>Observable&lt;AppUpdater&gt;</code> | An [AppUpdater](./kibana-plugin-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime. |
2529

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [navLinkStatus](./kibana-plugin-public.appbase.navlinkstatus.md)
4+
5+
## AppBase.navLinkStatus property
6+
7+
The initial status of the application's navLink. Defaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible` See [AppNavLinkStatus](./kibana-plugin-public.appnavlinkstatus.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
navLinkStatus?: AppNavLinkStatus;
13+
```

docs/development/core/public/kibana-plugin-public.appbase.tooltip_.md renamed to docs/development/core/public/kibana-plugin-public.appbase.status.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [tooltip$](./kibana-plugin-public.appbase.tooltip_.md)
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [status](./kibana-plugin-public.appbase.status.md)
44

5-
## AppBase.tooltip$ property
5+
## AppBase.status property
66

7-
An observable for a tooltip shown when hovering over app link.
7+
The initial status of the application. Defaulting to `accessible`
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
tooltip$?: Observable<string>;
12+
status?: AppStatus;
1313
```

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [tooltip](./kibana-plugin-public.appbase.tooltip.md)
4+
5+
## AppBase.tooltip property
6+
7+
A tooltip shown when hovering over app link.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
tooltip?: string;
13+
```

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [updater$](./kibana-plugin-public.appbase.updater_.md)
4+
5+
## AppBase.updater$ property
6+
7+
An [AppUpdater](./kibana-plugin-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
updater$?: Observable<AppUpdater>;
13+
```
14+
15+
## Example
16+
17+
How to update an application navLink at runtime
18+
19+
```ts
20+
// inside your plugin's setup function
21+
export class MyPlugin implements Plugin {
22+
private appUpdater = new BehaviorSubject<AppUpdater>(() => ({}));
23+
24+
setup({ application }) {
25+
application.register({
26+
id: 'my-app',
27+
title: 'My App',
28+
updater$: this.appUpdater,
29+
async mount(params) {
30+
const { renderApp } = await import('./application');
31+
return renderApp(params);
32+
},
33+
});
34+
}
35+
36+
start() {
37+
// later, when the navlink needs to be updated
38+
appUpdater.next(() => {
39+
navLinkStatus: AppNavLinkStatus.disabled,
40+
})
41+
}
42+
43+
```
44+

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ export interface ApplicationSetup
1616
| Method | Description |
1717
| --- | --- |
1818
| [register(app)](./kibana-plugin-public.applicationsetup.register.md) | Register an mountable application to the system. |
19+
| [registerAppUpdater(appUpdater$)](./kibana-plugin-public.applicationsetup.registerappupdater.md) | Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) fields of all applications at runtime.<!-- -->This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the <code>updater$</code> property of the registered application instead. |
1920
| [registerMountContext(contextName, provider)](./kibana-plugin-public.applicationsetup.registermountcontext.md) | Register a context provider for application mounting. Will only be available to applications that depend on the plugin that registered this context. Deprecated, use [CoreSetup.getStartServices()](./kibana-plugin-public.coresetup.getstartservices.md)<!-- -->. |
2021

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationSetup](./kibana-plugin-public.applicationsetup.md) &gt; [registerAppUpdater](./kibana-plugin-public.applicationsetup.registerappupdater.md)
4+
5+
## ApplicationSetup.registerAppUpdater() method
6+
7+
Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) fields of all applications at runtime.
8+
9+
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.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
registerAppUpdater(appUpdater$: Observable<AppUpdater>): void;
15+
```
16+
17+
## Parameters
18+
19+
| Parameter | Type | Description |
20+
| --- | --- | --- |
21+
| appUpdater$ | <code>Observable&lt;AppUpdater&gt;</code> | |
22+
23+
<b>Returns:</b>
24+
25+
`void`
26+
27+
## Example
28+
29+
How to register an application updater that disables some applications:
30+
31+
```ts
32+
// inside your plugin's setup function
33+
export class MyPlugin implements Plugin {
34+
setup({ application }) {
35+
application.registerAppUpdater(
36+
new BehaviorSubject<AppUpdater>(app => {
37+
if (myPluginApi.shouldDisable(app))
38+
return {
39+
status: AppStatus.inaccessible,
40+
};
41+
})
42+
);
43+
}
44+
}
45+
46+
```
47+

0 commit comments

Comments
 (0)