Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/development/core/public/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@

| 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. |
| [kibana-plugin-core-public](./kibana-plugin-core-public.md) | <p>The Kibana Core APIs for client-side plugins.</p><p>A plugin's <code>public/index</code> file must contain a named import, <code>plugin</code>, that implements which returns an object that implements .</p><p>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.</p> |

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +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.

<b>Signature:</b>
**Signature:**

```typescript
appRoute?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Custom capabilities defined by the app.

<b>Signature:</b>
**Signature:**

```typescript
capabilities?: Partial<Capabilities>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference

<b>Signature:</b>
**Signature:**

```typescript
category?: AppCategory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.

<b>Signature:</b>
**Signature:**

```typescript
chromeless?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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>
**Signature:**

```typescript
deepLinks?: AppDeepLink[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
defaultPath?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

If set to true, the application's route will only be checked against an exact match. Defaults to `false`<!-- -->.

<b>Signature:</b>
**Signature:**

```typescript
exactRoute?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The unique identifier of the application.

Can only be composed of alphanumeric characters, `-`<!-- -->, `:` and `_`

<b>Signature:</b>
**Signature:**

```typescript
id: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
keywords?: string[];
Expand Down
38 changes: 19 additions & 19 deletions docs/development/core/public/kibana-plugin-core-public.app.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,30 @@
## App interface


<b>Signature:</b>
**Signature:**

```typescript
export interface App<HistoryLocationState = unknown> extends AppNavOptions
```
<b>Extends:</b> AppNavOptions
**Extends:** 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&lt;Capabilities&gt; | <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&lt;HistoryLocationState&gt; | 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&lt;AppUpdater&gt; | <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. |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [appRoute?](./kibana-plugin-core-public.app.approute.md) | | string | _(Optional)_ 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&lt;Capabilities&gt; | _(Optional)_ Custom capabilities defined by the app. |
| [category?](./kibana-plugin-core-public.app.category.md) | | AppCategory | _(Optional)_ 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 | _(Optional)_ 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\[\] | <p>_(Optional)_ Input type for registering secondary in-app locations for an application.</p><p>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.</p> |
| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | | string | _(Optional)_ 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 | _(Optional)_ 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 | <p>The unique identifier of the application.</p><p>Can only be composed of alphanumeric characters, <code>-</code>, <code>:</code> and <code>_</code></p> |
| [keywords?](./kibana-plugin-core-public.app.keywords.md) | | string\[\] | _(Optional)_ 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&lt;HistoryLocationState&gt; | A mount function called when the user navigates to this app's route. |
| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | | AppNavLinkStatus | _(Optional)_ 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 | _(Optional)_ 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 | _(Optional)_ 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&lt;AppUpdater&gt; | _(Optional)_ 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. |

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

A mount function called when the user navigates to this app's route.

<b>Signature:</b>
**Signature:**

```typescript
mount: AppMount<HistoryLocationState>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +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-core-public.appnavlinkstatus.md)

<b>Signature:</b>
**Signature:**

```typescript
navLinkStatus?: AppNavLinkStatus;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
searchable?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The initial status of the application. Defaulting to `accessible`

<b>Signature:</b>
**Signature:**

```typescript
status?: AppStatus;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The title of the application.

<b>Signature:</b>
**Signature:**

```typescript
title: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
updater$?: Observable<AppUpdater>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The class name for top level \*and\* nested application wrappers to ensure proper layout

<b>Signature:</b>
**Signature:**

```typescript
APP_WRAPPER_CLASS = "kbnAppWrapper"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

If the visual label isn't appropriate for screen readers, can override it here

<b>Signature:</b>
**Signature:**

```typescript
ariaLabel?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
euiIconType?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Unique identifier for the categories

<b>Signature:</b>
**Signature:**

```typescript
id: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Label used for category name. Also used as aria-label if one isn't set.

<b>Signature:</b>
**Signature:**

```typescript
label: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@

A category definition for nav links to know where to sort them in the left hand nav

<b>Signature:</b>
**Signature:**

```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) |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [ariaLabel?](./kibana-plugin-core-public.appcategory.arialabel.md) | | string | _(Optional)_ If the visual label isn't appropriate for screen readers, can override it here |
| [euiIconType?](./kibana-plugin-core-public.appcategory.euiicontype.md) | | string | _(Optional)_ 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 | _(Optional)_ 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) |

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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>
**Signature:**

```typescript
order?: number;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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>
**Signature:**

```typescript
export declare type AppDeepLink = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.

See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md)

<b>Signature:</b>
**Signature:**

```typescript
export declare type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Possible type of actions on application leave.

<b>Signature:</b>
**Signature:**

```typescript
export declare enum AppLeaveActionType
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AppLeaveConfirmAction.callback property

<b>Signature:</b>
**Signature:**

```typescript
callback?: () => void;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleaveha

See

<b>Signature:</b>
**Signature:**

```typescript
export interface AppLeaveConfirmAction
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | () =&gt; void | <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 | |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | | () =&gt; void | _(Optional)_ |
| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | | string | |
| [title?](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | | string | _(Optional)_ |
| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | | AppLeaveActionType.confirm | |

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AppLeaveConfirmAction.text property

<b>Signature:</b>
**Signature:**

```typescript
text: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AppLeaveConfirmAction.title property

<b>Signature:</b>
**Signature:**

```typescript
title?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AppLeaveConfirmAction.type property

<b>Signature:</b>
**Signature:**

```typescript
type: AppLeaveActionType.confirm;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleaveha

See

<b>Signature:</b>
**Signature:**

```typescript
export interface AppLeaveDefaultAction
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | AppLeaveActionType.default | |
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | | AppLeaveActionType.default | |

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AppLeaveDefaultAction.type property

<b>Signature:</b>
**Signature:**

```typescript
type: AppLeaveActionType.default;
Expand Down
Loading