Skip to content

Commit dc9d16d

Browse files
elasticmachineelasticmachine
authored
Merge branch '7.x' into enhancedEsSearch-7.x
2 parents a43fe9e + 6bfb623 commit dc9d16d

3,746 files changed

Lines changed: 63053 additions & 44122 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.

‎docs/development/core/public/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88

99
| Package | Description |
1010
| --- | --- |
11-
| [kibana-plugin-public](./kibana-plugin-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. |
11+
| [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. |
1212

‎docs/development/core/public/kibana-plugin-core-public.app.approute.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-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md) &gt; [appRoute](./kibana-plugin-core-public.app.approute.md)
4+
5+
## App.appRoute property
6+
7+
Override the application's routing path from `/app/${id}`<!-- -->. Must be unique across registered applications. Should not include the base path from HTTP.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
appRoute?: string;
13+
```

‎docs/development/core/public/kibana-plugin-core-public.app.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-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md) &gt; [chromeless](./kibana-plugin-core-public.app.chromeless.md)
4+
5+
## App.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-core-public.app.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md)
4+
5+
## App interface
6+
7+
Extension of [common app properties](./kibana-plugin-core-public.appbase.md) with the mount function.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface App<HistoryLocationState = unknown> extends AppBase
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [appRoute](./kibana-plugin-core-public.app.approute.md) | <code>string</code> | 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. |
20+
| [chromeless](./kibana-plugin-core-public.app.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. |
21+
| [mount](./kibana-plugin-core-public.app.mount.md) | <code>AppMount&lt;HistoryLocationState&gt; &#124; AppMountDeprecated&lt;HistoryLocationState&gt;</code> | A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-core-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-core-public.appmountdeprecated.md)<!-- -->. |
22+

‎docs/development/core/public/kibana-plugin-core-public.app.mount.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md) &gt; [mount](./kibana-plugin-core-public.app.mount.md)
4+
5+
## App.mount property
6+
7+
A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-core-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-core-public.appmountdeprecated.md)<!-- -->.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
mount: AppMount<HistoryLocationState> | AppMountDeprecated<HistoryLocationState>;
13+
```
14+
15+
## Remarks
16+
17+
When function has two arguments, it will be called with a [context](./kibana-plugin-core-public.appmountcontext.md) as the first argument. This behavior is \*\*deprecated\*\*, and consumers should instead use [CoreSetup.getStartServices()](./kibana-plugin-core-public.coresetup.getstartservices.md)<!-- -->.
18+

‎docs/development/core/public/kibana-plugin-core-public.appbase.capabilities.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-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [capabilities](./kibana-plugin-core-public.appbase.capabilities.md)
4+
5+
## AppBase.capabilities property
6+
7+
Custom capabilities defined by the app.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
capabilities?: Partial<Capabilities>;
13+
```

‎docs/development/core/public/kibana-plugin-core-public.appbase.category.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-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [category](./kibana-plugin-core-public.appbase.category.md)
4+
5+
## AppBase.category property
6+
7+
The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
category?: AppCategory;
13+
```

‎docs/development/core/public/kibana-plugin-core-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-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [chromeless](./kibana-plugin-core-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-core-public.appbase.euiicontype.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-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [euiIconType](./kibana-plugin-core-public.appbase.euiicontype.md)
4+
5+
## AppBase.euiIconType property
6+
7+
A EUI iconType that will be used for the app's icon. This icon takes precendence over the `icon` property.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
euiIconType?: string;
13+
```

‎docs/development/core/public/kibana-plugin-core-public.appbase.icon.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-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [icon](./kibana-plugin-core-public.appbase.icon.md)
4+
5+
## AppBase.icon property
6+
7+
A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
icon?: string;
13+
```

0 commit comments

Comments
 (0)