Skip to content

Commit

Permalink
update ChromeBreadcrumb interface
Browse files Browse the repository at this point in the history
  • Loading branch information
thompsongl committed Oct 14, 2019
1 parent e21b22a commit 6c95b17
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 72 deletions.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,11 @@

[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md)

## ChromeBreadcrumb interface
## ChromeBreadcrumb type


<b>Signature:</b>

```typescript
export interface ChromeBreadcrumb
export declare type ChromeBreadcrumb = EuiBreadcrumb;
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| ["data-test-subj"](./kibana-plugin-public.chromebreadcrumb._data-test-subj_.md) | <code>string</code> | |
| [href](./kibana-plugin-public.chromebreadcrumb.href.md) | <code>string</code> | |
| [onClick](./kibana-plugin-public.chromebreadcrumb.onclick.md) | <code>MouseEventHandler&lt;HTMLButtonElement&gt;</code> | |
| [text](./kibana-plugin-public.chromebreadcrumb.text.md) | <code>string</code> | |

This file was deleted.

This file was deleted.

2 changes: 1 addition & 1 deletion docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [Capabilities](./kibana-plugin-public.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. |
| [ChromeBadge](./kibana-plugin-public.chromebadge.md) | |
| [ChromeBrand](./kibana-plugin-public.chromebrand.md) | |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [ChromeNavControl](./kibana-plugin-public.chromenavcontrol.md) | |
| [ChromeNavControls](./kibana-plugin-public.chromenavcontrols.md) | [APIs](./kibana-plugin-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. |
| [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) | |
Expand Down Expand Up @@ -90,6 +89,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| Type Alias | Description |
| --- | --- |
| [AppUnmount](./kibana-plugin-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeNavLinkUpdateableFields](./kibana-plugin-public.chromenavlinkupdateablefields.md) | |
| [HandlerContextType](./kibana-plugin-public.handlercontexttype.md) | Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-public.handlerfunction.md) to represent the type of the context. |
Expand Down
6 changes: 2 additions & 4 deletions src/core/public/chrome/chrome_service.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { map, takeUntil } from 'rxjs/operators';
import * as Url from 'url';

import { i18n } from '@kbn/i18n';
import { IconType, Breadcrumb } from '@elastic/eui';
import { IconType, Breadcrumb as EuiBreadcrumb } from '@elastic/eui';

import { InjectedMetadataStart } from '../injected_metadata';
import { NotificationsStart } from '../notifications';
Expand Down Expand Up @@ -59,9 +59,7 @@ export interface ChromeBrand {
}

/** @public */
export interface ChromeBreadcrumb extends Breadcrumb {
'data-test'?: string;
}
export type ChromeBreadcrumb = EuiBreadcrumb;

/** @public */
export type ChromeHelpExtension = (element: HTMLDivElement) => () => void;
Expand Down
13 changes: 2 additions & 11 deletions src/core/public/public.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
```ts

import { Breadcrumb } from '@elastic/eui';
import { IconType } from '@elastic/eui';
import { MouseEventHandler } from 'react';
import { Observable } from 'rxjs';
import React from 'react';
import * as Rx from 'rxjs';
Expand Down Expand Up @@ -103,16 +103,7 @@ export interface ChromeBrand {
}

// @public (undocumented)
export interface ChromeBreadcrumb {
// (undocumented)
'data-test-subj'?: string;
// (undocumented)
href?: string;
// (undocumented)
onClick?: MouseEventHandler<HTMLButtonElement>;
// (undocumented)
text: string;
}
export type ChromeBreadcrumb = Breadcrumb;

// @public (undocumented)
export type ChromeHelpExtension = (element: HTMLDivElement) => () => void;
Expand Down

0 comments on commit 6c95b17

Please sign in to comment.