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

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

View File

@ -189,15 +189,17 @@ export class Select implements ComponentInterface {
}
/**
* Opens the select overlay, it could be an alert, action-sheet or popover,
* based in `ion-select` settings.
* Open the select overlay. The overlay is either an alert, action sheet, or popover,
* depending on the `interface` property on the `ion-select`.
*
* @param event The user interface event that called the open.
*/
@Method()
async open(ev?: UIEvent): Promise<OverlaySelect | undefined> {
async open(event?: UIEvent): Promise<OverlaySelect | undefined> {
if (this.disabled || this.isExpanded) {
return undefined;
}
const overlay = this.overlay = await this.createOverlay(ev);
const overlay = this.overlay = await this.createOverlay(event);
this.isExpanded = true;
overlay.onDidDismiss().then(() => {
this.overlay = undefined;