Skip to content

Commit

Permalink
update generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Nov 19, 2019
1 parent 4aa0e2c commit 162ec01
Show file tree
Hide file tree
Showing 12 changed files with 93 additions and 10 deletions.
1 change: 0 additions & 1 deletion docs/development/core/public/kibana-plugin-public.app.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@ export interface App extends AppBase
| Property | Type | Description |
| --- | --- | --- |
| [chromeless](./kibana-plugin-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. |
| [mount](./kibana-plugin-public.app.mount.md) | <code>(context: AppMountContext, params: AppMountParameters) =&gt; AppUnmount &#124; Promise&lt;AppUnmount&gt;</code> | A mount function called when the user navigates to this app's route. |
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [chromeless](./kibana-plugin-public.app.chromeless.md)
[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)

## App.chromeless property
## AppBase.chromeless property

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## AppBase.id property

The unique identifier of the application

<b>Signature:</b>

```typescript
Expand Down
4 changes: 3 additions & 1 deletion docs/development/core/public/kibana-plugin-public.appbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ export interface AppBase
| Property | Type | Description |
| --- | --- | --- |
| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
| [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. |
| [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. |
| [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. |
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | |
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | The unique identifier of the application |
| [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
| [status](./kibana-plugin-public.appbase.status.md) | <code>AppStatus</code> | The status of the application. |
| [statusUpdater$](./kibana-plugin-public.appbase.statusupdater_.md) | <code>Observable&lt;AppStatusUpdater&gt;</code> | An [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime. |
| [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
| [tooltip](./kibana-plugin-public.appbase.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [statusUpdater$](./kibana-plugin-public.appbase.statusupdater_.md)

## AppBase.statusUpdater$ property

An [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime.

<b>Signature:</b>

```typescript
statusUpdater$?: Observable<AppStatusUpdater>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ export interface ApplicationSetup
| Method | Description |
| --- | --- |
| [register(app)](./kibana-plugin-public.applicationsetup.register.md) | Register an mountable application to the system. |
| [registerAppStatusUpdater(statusUpdater$)](./kibana-plugin-public.applicationsetup.registerappstatusupdater.md) | TODO |
| [registerAppStatusUpdater(statusUpdater$)](./kibana-plugin-public.applicationsetup.registerappstatusupdater.md) | Register an application status updater that can be used to change the [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) fields of all applications at runtime. |
| [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. |

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

## ApplicationSetup.registerAppStatusUpdater() method

TODO
Register an application status updater that can be used to change the [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) fields of all applications at runtime.

<b>Signature:</b>

Expand Down
22 changes: 22 additions & 0 deletions docs/development/core/public/kibana-plugin-public.appstatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppStatus](./kibana-plugin-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>2</code> | Application is not accessible. |
| inaccessibleWithDisabledNavLink | <code>1</code> | Application is not accessible, but visible in an inactive state in navigation. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md)

## AppStatusUpdater type

Status updater for applications.

<b>Signature:</b>

```typescript
export declare type AppStatusUpdater = (app: AppBase) => Partial<AppUpdatableFields> | undefined;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md)

## AppUpdatableFields type

Defines the list of fields that can be updated via an [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare type AppUpdatableFields = Pick<AppBase, 'status' | 'tooltip'>;
```
8 changes: 8 additions & 0 deletions docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ToastsApi](./kibana-plugin-public.toastsapi.md) | Methods for adding and removing global toast messages. |
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |

## Enumerations

| Enumeration | Description |
| --- | --- |
| [AppStatus](./kibana-plugin-public.appstatus.md) | Accessibility status of an application. |

## Interfaces

| Interface | Description |
Expand Down Expand Up @@ -96,7 +102,9 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->

| Type Alias | Description |
| --- | --- |
| [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md) | Status updater for applications. |
| [AppUnmount](./kibana-plugin-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. |
| [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) | Defines the list of fields that can be updated via an [AppStatusUpdater](./kibana-plugin-public.appstatusupdater.md)<!-- -->. |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeNavLinkUpdateableFields](./kibana-plugin-public.chromenavlinkupdateablefields.md) | |
Expand Down
19 changes: 15 additions & 4 deletions src/core/public/public.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,28 @@ import { UserProvidedValues as UserProvidedValues_2 } from 'src/core/server/type

// @public
export interface App extends AppBase {
chromeless?: boolean;
mount: (context: AppMountContext, params: AppMountParameters) => AppUnmount | Promise<AppUnmount>;
}

// @public (undocumented)
export interface AppBase {
capabilities?: Partial<Capabilities>;
chromeless?: boolean;
euiIconType?: string;
icon?: string;
// (undocumented)
id: string;
// @internal
legacy?: boolean;
order?: number;
// Warning: (ae-forgotten-export) The symbol "AppStatus" needs to be exported by the entry point index.d.ts
status?: AppStatus;
statusUpdater$?: Observable<AppStatusUpdater>;
title: string;
tooltip?: string;
}

// @public (undocumented)
export interface ApplicationSetup {
register(app: App): void;
// Warning: (ae-forgotten-export) The symbol "AppStatusUpdater" needs to be exported by the entry point index.d.ts
registerAppStatusUpdater(statusUpdater$: Observable<AppStatusUpdater>): void;
registerMountContext<T extends keyof AppMountContext>(contextName: T, provider: IContextProvider<App['mount'], T>): void;
}
Expand Down Expand Up @@ -80,9 +78,22 @@ export interface AppMountParameters {
element: HTMLElement;
}

// @public
export enum AppStatus {
accessible = 0,
inaccessible = 2,
inaccessibleWithDisabledNavLink = 1
}

// @public
export type AppStatusUpdater = (app: AppBase) => Partial<AppUpdatableFields> | undefined;

// @public
export type AppUnmount = () => void;

// @public
export type AppUpdatableFields = Pick<AppBase, 'status' | 'tooltip'>;

// @public
export interface Capabilities {
[key: string]: Record<string, boolean | Record<string, boolean>>;
Expand Down

0 comments on commit 162ec01

Please sign in to comment.