javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-10 00:27:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): update method and parameter descriptions (#18075)

Browse Source
This commit is contained in:
Brandy Carney
2019-04-23 12:59:25 -04:00
committed by GitHub
parent bd96491d03
commit 464ec3b70a
56 changed files with 879 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
core/src/components/tabs/readme.md
View File

@ -273,7 +273,7 @@ export default Example;
### `getSelected() => Promise<string | undefined>`
Get the currently selected tab
Get the currently selected tab.
#### Returns
@ -283,13 +283,13 @@ Type: `Promise<string | undefined>`
### `getTab(tab: string | HTMLIonTabElement) => Promise<HTMLIonTabElement | undefined>`
Get the tab element given the tab name
Get a specific tab by the value of its `tab` property or an element reference.
#### Parameters
| Name | Type | Description |
| ----- | ----------------------------- | ----------- |
| `tab` | `HTMLIonTabElement \| string` | |
| Name | Type | Description |
| ----- | ----------------------------- | --------------------------------------------------------------------------------------------------- |
| `tab` | `HTMLIonTabElement \| string` | The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. |
#### Returns
@ -299,13 +299,13 @@ Type: `Promise<HTMLIonTabElement | undefined>`
### `select(tab: string | HTMLIonTabElement) => Promise<boolean>`
Index or the Tab instance, of the tab to select.
Select a tab by the value of its `tab` property or an element reference.
#### Parameters
| Name | Type | Description |
| ----- | ----------------------------- | ----------- |
| `tab` | `HTMLIonTabElement \| string` | |
| Name | Type | Description |
| ----- | ----------------------------- | --------------------------------------------------------------------------------------------------- |
| `tab` | `HTMLIonTabElement \| string` | The tab instance to select. If passed a string, it should be the value of the tab's `tab` property. |
#### Returns

10
core/src/components/tabs/tabs.tsx
View File

@ -85,7 +85,9 @@ export class Tabs implements NavOutlet {
}
/**
* Index or the Tab instance, of the tab to select.
* Select a tab by the value of its `tab` property or an element reference.
*
* @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property.
*/
@Method()
async select(tab: string | HTMLIonTabElement): Promise<boolean> {
@ -101,7 +103,9 @@ export class Tabs implements NavOutlet {
}
/**
* Get the tab element given the tab name
* Get a specific tab by the value of its `tab` property or an element reference.
*
* @param tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property.
*/
@Method()
async getTab(tab: string | HTMLIonTabElement): Promise<HTMLIonTabElement | undefined> {
@ -116,7 +120,7 @@ export class Tabs implements NavOutlet {
}
/**
* Get the currently selected tab
* Get the currently selected tab.
*/
@Method()
getSelected(): Promise<string | undefined> {