Skip to content

Commit f6eba8e

Browse files
committed
docs
1 parent cc62162 commit f6eba8e

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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; [ChromeStart](./kibana-plugin-core-public.chromestart.md) &gt; [getBreadcrumbsAppendExtension$](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md)
4+
5+
## ChromeStart.getBreadcrumbsAppendExtension$() method
6+
7+
Get an observable of the current extension appended to breadcrumbs
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getBreadcrumbsAppendExtension$(): Observable<ChromeBreadcrumbsAppendExtension | undefined>;
13+
```
14+
<b>Returns:</b>
15+
16+
`Observable<ChromeBreadcrumbsAppendExtension | undefined>`
17+

docs/development/core/public/kibana-plugin-core-public.chromestart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ core.chrome.setHelpExtension(elem => {
5555
| [getBadge$()](./kibana-plugin-core-public.chromestart.getbadge_.md) | Get an observable of the current badge |
5656
| [getBrand$()](./kibana-plugin-core-public.chromestart.getbrand_.md) | Get an observable of the current brand information. |
5757
| [getBreadcrumbs$()](./kibana-plugin-core-public.chromestart.getbreadcrumbs_.md) | Get an observable of the current list of breadcrumbs |
58+
| [getBreadcrumbsAppendExtension$()](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md) | Get an observable of the current extension appended to breadcrumbs |
5859
| [getCustomNavLink$()](./kibana-plugin-core-public.chromestart.getcustomnavlink_.md) | Get an observable of the current custom nav link |
5960
| [getHelpExtension$()](./kibana-plugin-core-public.chromestart.gethelpextension_.md) | Get an observable of the current custom help conttent |
6061
| [getIsNavDrawerLocked$()](./kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md) | Get an observable of the current locked state of the nav drawer. |
@@ -64,6 +65,7 @@ core.chrome.setHelpExtension(elem => {
6465
| [setBadge(badge)](./kibana-plugin-core-public.chromestart.setbadge.md) | Override the current badge |
6566
| [setBrand(brand)](./kibana-plugin-core-public.chromestart.setbrand.md) | Set the brand configuration. |
6667
| [setBreadcrumbs(newBreadcrumbs)](./kibana-plugin-core-public.chromestart.setbreadcrumbs.md) | Override the current set of breadcrumbs |
68+
| [setBreadcrumbsAppendExtension(breadcrumbsAppendExtension)](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md) | Mount an element next to the last breadcrumb |
6769
| [setCustomNavLink(newCustomNavLink)](./kibana-plugin-core-public.chromestart.setcustomnavlink.md) | Override the current set of custom nav link |
6870
| [setHelpExtension(helpExtension)](./kibana-plugin-core-public.chromestart.sethelpextension.md) | Override the current set of custom help content |
6971
| [setHelpSupportUrl(url)](./kibana-plugin-core-public.chromestart.sethelpsupporturl.md) | Override the default support URL shown in the help menu |
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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; [ChromeStart](./kibana-plugin-core-public.chromestart.md) &gt; [setBreadcrumbsAppendExtension](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md)
4+
5+
## ChromeStart.setBreadcrumbsAppendExtension() method
6+
7+
Mount an element next to the last breadcrumb
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
setBreadcrumbsAppendExtension(breadcrumbsAppendExtension?: ChromeBreadcrumbsAppendExtension): void;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| breadcrumbsAppendExtension | <code>ChromeBreadcrumbsAppendExtension</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`void`
24+

src/core/public/public.api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,8 @@ export interface ChromeStart {
343343
getBadge$(): Observable<ChromeBadge | undefined>;
344344
getBrand$(): Observable<ChromeBrand>;
345345
getBreadcrumbs$(): Observable<ChromeBreadcrumb[]>;
346+
// Warning: (ae-forgotten-export) The symbol "ChromeBreadcrumbsAppendExtension" needs to be exported by the entry point index.d.ts
347+
getBreadcrumbsAppendExtension$(): Observable<ChromeBreadcrumbsAppendExtension | undefined>;
346348
getCustomNavLink$(): Observable<Partial<ChromeNavLink> | undefined>;
347349
getHelpExtension$(): Observable<ChromeHelpExtension | undefined>;
348350
getIsNavDrawerLocked$(): Observable<boolean>;
@@ -355,6 +357,7 @@ export interface ChromeStart {
355357
setBadge(badge?: ChromeBadge): void;
356358
setBrand(brand: ChromeBrand): void;
357359
setBreadcrumbs(newBreadcrumbs: ChromeBreadcrumb[]): void;
360+
setBreadcrumbsAppendExtension(breadcrumbsAppendExtension?: ChromeBreadcrumbsAppendExtension): void;
358361
setCustomNavLink(newCustomNavLink?: Partial<ChromeNavLink>): void;
359362
setHelpExtension(helpExtension?: ChromeHelpExtension): void;
360363
setHelpSupportUrl(url: string): void;

0 commit comments

Comments
 (0)