re-generate documentation and extend ui_app

elastic · Jan 24, 2020 · 374d8b2 · 374d8b2
1 parent 5200092
commit 374d8b2
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/...lopment/core/public/kibana-plugin-public.chromenavlink.disablesuburltracking.md b/...lopment/core/public/kibana-plugin-public.chromenavlink.disablesuburltracking.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [disableSubUrlTracking](./kibana-plugin-public.chromenavlink.disablesuburltracking.md)
+
+## ChromeNavLink.disableSubUrlTracking property
+
+> Warning: This API is now obsolete.
+> 
+> 
+
+A flag that tells legacy chrome to ignore the link when tracking sub-urls
+
+<b>Signature:</b>
+
+```typescript
+readonly disableSubUrlTracking?: boolean;
+```
diff --git a/docs/development/core/public/kibana-plugin-public.chromenavlink.md b/docs/development/core/public/kibana-plugin-public.chromenavlink.md
@@ -19,6 +19,7 @@ export interface ChromeNavLink
 |  [baseUrl](./kibana-plugin-public.chromenavlink.baseurl.md) | <code>string</code> | The base route used to open the root of an application. |
 |  [category](./kibana-plugin-public.chromenavlink.category.md) | <code>AppCategory</code> | The category the app lives in |
 |  [disabled](./kibana-plugin-public.chromenavlink.disabled.md) | <code>boolean</code> | Disables a link from being clickable. |
+|  [disableSubUrlTracking](./kibana-plugin-public.chromenavlink.disablesuburltracking.md) | <code>boolean</code> | A flag that tells legacy chrome to ignore the link when tracking sub-urls |
 |  [euiIconType](./kibana-plugin-public.chromenavlink.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. |
 |  [hidden](./kibana-plugin-public.chromenavlink.hidden.md) | <code>boolean</code> | Hides a link from the navigation. |
 |  [icon](./kibana-plugin-public.chromenavlink.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. |

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -263,6 +263,8 @@ export interface ChromeNavLink {
     readonly category?: AppCategory;
     // @deprecated
     readonly disabled?: boolean;
+    // @deprecated
+    readonly disableSubUrlTracking?: boolean;
     readonly euiIconType?: string;
     readonly hidden?: boolean;
     readonly icon?: string;

diff --git a/src/legacy/ui/ui_apps/ui_app.js b/src/legacy/ui/ui_apps/ui_app.js
@@ -31,6 +31,7 @@ export class UiApp {
       euiIconType,
       hidden,
       linkToLastSubUrl,
+      disableSubUrlTracking,
       listed,
       category,
       url = `/app/${id}`,
@@ -47,6 +48,7 @@ export class UiApp {
     this._icon = icon;
     this._euiIconType = euiIconType;
     this._linkToLastSubUrl = linkToLastSubUrl;
+    this._disableSubUrlTracking = disableSubUrlTracking;
     this._category = category;
     this._hidden = hidden;
     this._listed = listed;
@@ -70,6 +72,7 @@ export class UiApp {
         euiIconType: this._euiIconType,
         url: this._url,
         linkToLastSubUrl: this._linkToLastSubUrl,
+        disableSubUrlTracking: this._disableSubUrlTracking,
         category: this._category,
       });
     }
@@ -118,6 +121,7 @@ export class UiApp {
       main: this._main,
       navLink: this._navLink,
       linkToLastSubUrl: this._linkToLastSubUrl,
+      disableSubUrlTracking: this._disableSubUrlTracking,
       category: this._category,
     };
   }