From db121ac4738a6de85ab8e878f8fa0e20488e7a1f Mon Sep 17 00:00:00 2001 From: Shawn Taylor Date: Wed, 26 Apr 2023 10:57:00 -0400 Subject: [PATCH] docs(tabs): document methods only available for vanilla (#27269) When using Angular, React, or Vue, the use of tabs is coupled to the framework's routing. These methods are only available when using tabs with vanilla JavaScript. Issue number: N/A --------- ## What is the new behavior? - Adds more context to the description of the methods on tabs ## Does this introduce a breaking change? - [ ] Yes - [x] No ## Other information --- core/src/components.d.ts | 6 +++--- core/src/components/tabs/tabs.tsx | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 3b219717f3..1344e0d863 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -2888,16 +2888,16 @@ export namespace Components { interface IonTabs { "getRouteId": () => Promise; /** - * Get the currently selected tab. + * Get the currently selected tab. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. */ "getSelected": () => Promise; /** - * Get a specific tab by the value of its `tab` property or an element reference. + * Get a specific tab by the value of its `tab` property or an element reference. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. * @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. */ "getTab": (tab: string | HTMLIonTabElement) => Promise; /** - * Select a tab by the value of its `tab` property or an element reference. + * Select a tab by the value of its `tab` property or an element reference. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. * @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. */ "select": (tab: string | HTMLIonTabElement) => Promise; diff --git a/core/src/components/tabs/tabs.tsx b/core/src/components/tabs/tabs.tsx index 6b34990127..5b744db1ad 100644 --- a/core/src/components/tabs/tabs.tsx +++ b/core/src/components/tabs/tabs.tsx @@ -63,7 +63,7 @@ export class Tabs implements NavOutlet { } /** - * Select a tab by the value of its `tab` property or an element reference. + * Select a tab by the value of its `tab` property or an element reference. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. * * @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. */ @@ -81,7 +81,7 @@ export class Tabs implements NavOutlet { } /** - * Get a specific tab by the value of its `tab` property or an element reference. + * Get a specific tab by the value of its `tab` property or an element reference. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. * * @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. */ @@ -91,7 +91,7 @@ export class Tabs implements NavOutlet { } /** - * Get the currently selected tab. + * Get the currently selected tab. This method is only available for vanilla JavaScript projects. The Angular, React, and Vue implementations of tabs are coupled to each framework's router. */ @Method() getSelected(): Promise {