|
4 | 4 |
|
5 | 5 | ## App interface |
6 | 6 |
|
7 | | -Extension of [common app properties](./kibana-plugin-core-public.appbase.md) with the mount function. |
| 7 | +Extension of with the mount function. |
8 | 8 |
|
9 | 9 | <b>Signature:</b> |
10 | 10 |
|
11 | 11 | ```typescript |
12 | | -export interface App<HistoryLocationState = unknown> extends AppBase |
| 12 | +export interface App<HistoryLocationState = unknown> |
13 | 13 | ``` |
14 | 14 |
|
15 | 15 | ## Properties |
16 | 16 |
|
17 | 17 | | Property | Type | Description | |
18 | 18 | | --- | --- | --- | |
19 | 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 | +| [capabilities](./kibana-plugin-core-public.app.capabilities.md) | <code>Partial<Capabilities></code> | Custom capabilities defined by the app. | |
| 21 | +| [category](./kibana-plugin-core-public.app.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference | |
20 | 22 | | [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. | |
| 23 | +| [defaultPath](./kibana-plugin-core-public.app.defaultpath.md) | <code>string</code> | 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. | |
| 24 | +| [euiIconType](./kibana-plugin-core-public.app.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. | |
21 | 25 | | [exactRoute](./kibana-plugin-core-public.app.exactroute.md) | <code>boolean</code> | If set to true, the application's route will only be checked against an exact match. Defaults to <code>false</code>. | |
| 26 | +| [icon](./kibana-plugin-core-public.app.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. | |
| 27 | +| [id](./kibana-plugin-core-public.app.id.md) | <code>string</code> | The unique identifier of the application | |
22 | 28 | | [mount](./kibana-plugin-core-public.app.mount.md) | <code>AppMount<HistoryLocationState> | AppMountDeprecated<HistoryLocationState></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)<!-- -->. | |
| 29 | +| [navLinkStatus](./kibana-plugin-core-public.app.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-core-public.appnavlinkstatus.md) | |
| 30 | +| [order](./kibana-plugin-core-public.app.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. | |
| 31 | +| [status](./kibana-plugin-core-public.app.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> | |
| 32 | +| [title](./kibana-plugin-core-public.app.title.md) | <code>string</code> | The title of the application. | |
| 33 | +| [tooltip](./kibana-plugin-core-public.app.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. | |
| 34 | +| [updater$](./kibana-plugin-core-public.app.updater_.md) | <code>Observable<AppUpdater></code> | 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. | |
23 | 35 |
|
0 commit comments