refactor(angular): picker controller uses correct core instance (#28521)

Issue number: Internal

---------

<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->

<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->

## What is the current behavior?
As a takeaway from our learning session about a menuController bug in
Ionic Angular, the team would like to update our other providers to use
the same architecture as the menuController to prevent this kind of
issue from happening again in the future.

We also noticed that the common provider does not provide much value and
it's easier to just have two separate implementations in `src` and
`standalone`. (There wasn't much code we could de-duplicate)

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

- Removed the common picker provider in favor of separate ones in
src/standalone

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!-- If this introduces a breaking change, please describe the impact
and migration path for existing applications below. -->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->
This commit is contained in:
Shawn Taylor
2023-11-16 07:57:02 -05:00
committed by GitHub
parent f143bd0a11
commit 9d57758e3e
11 changed files with 71 additions and 10 deletions

View File

@ -1,7 +1,6 @@
export { AlertController } from './providers/alert-controller'; export { AlertController } from './providers/alert-controller';
export { LoadingController } from './providers/loading-controller'; export { LoadingController } from './providers/loading-controller';
export { MenuController } from './providers/menu-controller'; export { MenuController } from './providers/menu-controller';
export { PickerController } from './providers/picker-controller';
export { DomController } from './providers/dom-controller'; export { DomController } from './providers/dom-controller';
export { NavController } from './providers/nav-controller'; export { NavController } from './providers/nav-controller';

View File

@ -22,7 +22,6 @@ export * from './directives/validators';
export { export {
AlertController, AlertController,
LoadingController, LoadingController,
PickerController,
DomController, DomController,
NavController, NavController,
Config, Config,
@ -40,6 +39,7 @@ export { ActionSheetController } from './providers/action-sheet-controller';
export { GestureController } from './providers/gesture-controller'; export { GestureController } from './providers/gesture-controller';
export { MenuController } from './providers/menu-controller'; export { MenuController } from './providers/menu-controller';
export { ModalController } from './providers/modal-controller'; export { ModalController } from './providers/modal-controller';
export { PickerController } from './providers/picker-controller';
export { PopoverController } from './providers/popover-controller'; export { PopoverController } from './providers/popover-controller';
export { ToastController } from './providers/toast-controller'; export { ToastController } from './providers/toast-controller';

View File

@ -0,0 +1,13 @@
import { Injectable } from '@angular/core';
import { OverlayBaseController } from '@ionic/angular/common';
import type { PickerOptions } from '@ionic/core';
import { pickerController } from '@ionic/core';
@Injectable({
providedIn: 'root',
})
export class PickerController extends OverlayBaseController<PickerOptions, HTMLIonPickerElement> {
constructor() {
super(pickerController);
}
}

View File

@ -10,12 +10,12 @@ export { AnimationController } from './providers/animation-controller';
export { GestureController } from './providers/gesture-controller'; export { GestureController } from './providers/gesture-controller';
export { MenuController } from './providers/menu-controller'; export { MenuController } from './providers/menu-controller';
export { ModalController } from './providers/modal-controller'; export { ModalController } from './providers/modal-controller';
export { PickerController } from './providers/picker-controller';
export { PopoverController } from './providers/popover-controller'; export { PopoverController } from './providers/popover-controller';
export { ToastController } from './providers/toast-controller'; export { ToastController } from './providers/toast-controller';
export { export {
AlertController, AlertController,
LoadingController, LoadingController,
PickerController,
DomController, DomController,
NavController, NavController,
Config, Config,

View File

@ -1,8 +1,8 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { OverlayBaseController } from '@ionic/angular/common';
import type { PickerOptions } from '@ionic/core/components'; import type { PickerOptions } from '@ionic/core/components';
import { pickerController } from '@ionic/core/components'; import { pickerController } from '@ionic/core/components';
import { defineCustomElement } from '@ionic/core/components/ion-picker.js';
import { OverlayBaseController } from '../utils/overlay';
@Injectable({ @Injectable({
providedIn: 'root', providedIn: 'root',
@ -10,5 +10,8 @@ import { OverlayBaseController } from '../utils/overlay';
export class PickerController extends OverlayBaseController<PickerOptions, HTMLIonPickerElement> { export class PickerController extends OverlayBaseController<PickerOptions, HTMLIonPickerElement> {
constructor() { constructor() {
super(pickerController); super(pickerController);
// TODO: FW-5415 may remove the need for this
defineCustomElement();
} }
} }

View File

@ -39,5 +39,11 @@ describe('Providers', () => {
cy.get('ion-action-sheet').should('be.visible'); cy.get('ion-action-sheet').should('be.visible');
}); });
it('should open a picker', () => {
cy.get('button#open-picker').click();
cy.get('ion-picker').should('be.visible');
});
}); });

View File

@ -1,7 +1,7 @@
describe('Overlay Controllers', () => { describe('Overlay Controllers', () => {
beforeEach(() => { beforeEach(() => {
cy.visit('/standalone/overlay-controllers'); cy.visit('/standalone/overlay-controllers');
}) });
it('should present a modal', () => { it('should present a modal', () => {
cy.get('button#open-modal').click(); cy.get('button#open-modal').click();
@ -9,9 +9,15 @@ describe('Overlay Controllers', () => {
cy.get('ion-modal app-dialog-content').should('be.visible'); cy.get('ion-modal app-dialog-content').should('be.visible');
}); });
it('should present a picker', () => {
cy.get('button#open-picker').click();
cy.get('ion-picker .picker-button').should('be.visible');
});
it('should present a popover', () => { it('should present a popover', () => {
cy.get('button#open-popover').click(); cy.get('button#open-popover').click();
cy.get('ion-popover app-dialog-content').should('be.visible'); cy.get('ion-popover app-dialog-content').should('be.visible');
}); });
}) });

View File

@ -46,4 +46,5 @@
<button id="set-menu-count" (click)="setMenuCount()">Set Menu Count</button> <button id="set-menu-count" (click)="setMenuCount()">Set Menu Count</button>
<button id="open-action-sheet" (click)="openActionSheet()">Open Action Sheet</button> <button id="open-action-sheet" (click)="openActionSheet()">Open Action Sheet</button>
<button id="open-picker" (click)="openPicker()">Open Picker</button>
</ion-content> </ion-content>

View File

@ -28,7 +28,7 @@ export class ProvidersComponent {
alertCtrl: AlertController, alertCtrl: AlertController,
loadingCtrl: LoadingController, loadingCtrl: LoadingController,
private menuCtrl: MenuController, private menuCtrl: MenuController,
pickerCtrl: PickerController, private pickerCtrl: PickerController,
modalCtrl: ModalController, modalCtrl: ModalController,
platform: Platform, platform: Platform,
popoverCtrl: PopoverController, popoverCtrl: PopoverController,
@ -96,4 +96,18 @@ export class ProvidersComponent {
await actionSheet.present(); await actionSheet.present();
} }
async openPicker() {
const picker = await this.pickerCtrl.create({
columns: [],
buttons: [
{
text: 'Cancel',
role: 'cancel',
},
]
});
await picker.present();
}
} }

View File

@ -1,4 +1,5 @@
<div> <div>
<button id="open-modal" (click)="openModal()">Open Modal</button> <button id="open-modal" (click)="openModal()">Open Modal</button>
<button id="open-picker" (click)="openPicker()">Open Picker</button>
<button id="open-popover" (click)="openPopover($event)">Open Popover</button> <button id="open-popover" (click)="openPopover($event)">Open Popover</button>
</div> </div>

View File

@ -1,5 +1,5 @@
import { Component } from '@angular/core'; import { Component } from '@angular/core';
import { ModalController, PopoverController } from '@ionic/angular/standalone'; import { ModalController, PickerController, PopoverController } from '@ionic/angular/standalone';
@Component({ @Component({
selector: 'app-overlay-controllers', selector: 'app-overlay-controllers',
@ -7,7 +7,11 @@ import { ModalController, PopoverController } from '@ionic/angular/standalone';
standalone: true, standalone: true,
}) })
export class OverlayControllersComponent { export class OverlayControllersComponent {
constructor(private modalCtrl: ModalController, private popoverCtrl: PopoverController) {} constructor(
private modalCtrl: ModalController,
private pickerCtrl: PickerController,
private popoverCtrl: PopoverController
) {}
async openModal() { async openModal() {
const modal = await this.modalCtrl.create({ const modal = await this.modalCtrl.create({
@ -17,6 +21,20 @@ export class OverlayControllersComponent {
await modal.present(); await modal.present();
} }
async openPicker() {
const picker = await this.pickerCtrl.create({
columns: [],
buttons: [
{
text: 'Cancel',
role: 'cancel',
},
],
});
await picker.present();
}
async openPopover(ev: MouseEvent) { async openPopover(ev: MouseEvent) {
const popover = await this.popoverCtrl.create({ const popover = await this.popoverCtrl.create({
component: DialogComponent, component: DialogComponent,