Skip to content

feat(modal): add IonModalToken for injecting modal elements in Angular components #30474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 23, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/angular/common/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
export { MenuController } from './providers/menu-controller';
export { DomController } from './providers/dom-controller';
export { MenuController } from './providers/menu-controller';
export { NavController } from './providers/nav-controller';

export { Config, ConfigToken } from './providers/config';
export { Platform } from './providers/platform';

export { bindLifecycleEvents, AngularDelegate } from './providers/angular-delegate';
export { AngularDelegate, bindLifecycleEvents, IonModalToken } from './providers/angular-delegate';

export type { IonicWindow } from './types/interfaces';
export type { ViewWillEnter, ViewWillLeave, ViewDidEnter, ViewDidLeave } from './types/ionic-lifecycle-hooks';
export type { ViewDidEnter, ViewDidLeave, ViewWillEnter, ViewWillLeave } from './types/ionic-lifecycle-hooks';

export { NavParams } from './directives/navigation/nav-params';

export { IonPopover } from './overlays/popover';
export { IonModal } from './overlays/modal';
export { IonPopover } from './overlays/popover';

export { IonRouterOutlet, provideComponentInputBinding } from './directives/navigation/router-outlet';

export * from './directives/control-value-accessors';
export { IonBackButton } from './directives/navigation/back-button';
export { IonNav } from './directives/navigation/nav';
export {
RouterLinkDelegateDirective,
RouterLinkWithHrefDelegateDirective,
} from './directives/navigation/router-link-delegate';
export { IonNav } from './directives/navigation/nav';
export { IonTabs } from './directives/navigation/tabs';
export * from './directives/control-value-accessors';

export { ProxyCmp } from './utils/proxy';

export { IonicRouteStrategy } from './utils/routing';
export { OverlayBaseController } from './utils/overlay';
export { IonicRouteStrategy } from './utils/routing';

export { raf } from './utils/util';
26 changes: 20 additions & 6 deletions packages/angular/common/src/providers/angular-delegate.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import {
ApplicationRef,
NgZone,
Injectable,
Injector,
ComponentRef,
createComponent,
EnvironmentInjector,
inject,
createComponent,
Injectable,
InjectionToken,
ComponentRef,
Injector,
NgZone,
} from '@angular/core';
import {
FrameworkDelegate,
@@ -22,6 +22,9 @@ import { NavParams } from '../directives/navigation/nav-params';

import { ConfigToken } from './config';

// Token for injecting the modal element
export const IonModalToken = new InjectionToken<HTMLIonModalElement>('IonModalToken');

// TODO(FW-2827): types

@Injectable()
@@ -142,8 +145,19 @@ export const attachView = (
* The modern approach is to access the data directly
* from the component's class instance.
*/
const providers = getProviders(params);

// If this is an ion-modal, provide the modal element as an injectable
// so components inside the modal can inject it directly
if (container.tagName.toLowerCase() === 'ion-modal') {
providers.push({
provide: IonModalToken,
useValue: container,
});
}

const childInjector = Injector.create({
providers: getProviders(params),
providers,
parent: injector,
});

1 change: 1 addition & 0 deletions packages/angular/src/index.ts
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@ export {
AngularDelegate,
NavParams,
IonicRouteStrategy,
IonModalToken,
ViewWillEnter,
ViewWillLeave,
ViewDidEnter,
1 change: 1 addition & 0 deletions packages/angular/standalone/src/index.ts
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ export {
Config,
Platform,
NavParams,
IonModalToken,
IonicRouteStrategy,
ViewWillEnter,
ViewDidEnter,
4 changes: 2 additions & 2 deletions packages/angular/test/apps/ng18/package.json
Original file line number Diff line number Diff line change
@@ -29,8 +29,8 @@
"@angular/platform-server": "^18.0.0",
"@angular/router": "^18.0.0",
"@angular/ssr": "^18.0.0",
"@ionic/angular": "^8.0.0",
"@ionic/angular-server": "^8.0.0",
"@ionic/angular": "^8.6.0",
"@ionic/angular-server": "^8.6.0",
"core-js": "^3.33.2",
"express": "^4.15.2",
"ionicons": "^7.2.0",
4 changes: 2 additions & 2 deletions packages/angular/test/apps/ng19/package.json
Original file line number Diff line number Diff line change
@@ -29,8 +29,8 @@
"@angular/platform-server": "^19.0.0",
"@angular/router": "^19.0.0",
"@angular/ssr": "^19.0.2",
"@ionic/angular": "^8.4.0",
"@ionic/angular-server": "^8.4.0",
"@ionic/angular": "^8.6.0",
"@ionic/angular-server": "^8.6.0",
"core-js": "^3.33.2",
"express": "^4.18.2",
"ionicons": "^7.2.0",
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>
modal works!
<ion-button (click)="close()">Close Modal</ion-button>
</p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { Component, Inject } from '@angular/core';
import { IonButton, IonModalToken } from "@ionic/angular/standalone";

@Component({
selector: 'app-modal',
templateUrl: './modal.component.html',
imports: [IonButton],
standalone: true,
})
export class ModalComponent {
constructor(@Inject(IonModalToken) private modalToken: HTMLIonModalElement) {
this.modalToken.onDidDismiss().then(() => {
console.log('Modal dismissed');
});
}

public close() {
this.modalToken.dismiss();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<ion-button (click)="open()">Open Modal</ion-button>

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Component } from '@angular/core';
import { IonButton } from '@ionic/angular/standalone';
import { ProgramaticModalService } from './programatic-modal.service';

@Component({
selector: 'app-test',
templateUrl: './programatic-modal.component.html',
standalone: true,
imports: [IonButton]
})
export class ProgramaticModalComponent {
constructor(private modalService: ProgramaticModalService) {}

public open() {
this.modalService.open();
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { inject, Injectable } from '@angular/core';
import { ModalController } from "@ionic/angular/standalone";
import { ModalComponent } from "./modal/modal.component";

@Injectable({
providedIn: 'root'
})
export class ProgramaticModalService {
#modalController = inject(ModalController);

async open() {
const modal = await this.#modalController.create({
component: ModalComponent,
focusTrap: true,
});
await modal.present();
}
}
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ export const routes: Routes = [
{ path: 'action-sheet-controller', loadComponent: () => import('../action-sheet-controller/action-sheet-controller.component').then(c => c.ActionSheetControllerComponent) },
{ path: 'popover', loadComponent: () => import('../popover/popover.component').then(c => c.PopoverComponent) },
{ path: 'modal', loadComponent: () => import('../modal/modal.component').then(c => c.ModalComponent) },
{ path: 'programatic-modal', loadComponent: () => import('../programatic-modal/programatic-modal.component').then(c => c.ProgramaticModalComponent) },
{ path: 'router-outlet', loadComponent: () => import('../router-outlet/router-outlet.component').then(c => c.RouterOutletComponent) },
{ path: 'back-button', loadComponent: () => import('../back-button/back-button.component').then(c => c.BackButtonComponent) },
{ path: 'router-link', loadComponent: () => import('../router-link/router-link.component').then(c => c.RouterLinkComponent) },
Original file line number Diff line number Diff line change
@@ -85,6 +85,11 @@
Modal Test
</ion-label>
</ion-item>
<ion-item routerLink="/standalone/programatic-modal">
<ion-label>
Programatic Modal Test
</ion-label>
</ion-item>
<ion-item routerLink="/standalone/overlay-controllers">
<ion-label>
Overlay Controllers Test
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<p>
modal works!
</p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Component } from '@angular/core';
import { IonButton } from "@ionic/angular/standalone";

@Component({
selector: 'app-modal',
templateUrl: './modal.component.html',
imports: [IonButton],
standalone: true,
})
export class ModalComponent {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<ion-button (click)="open()">Open Modal</ion-button>

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Component } from '@angular/core';
import { IonButton } from '@ionic/angular/standalone';
import { ProgramaticModalService } from './programatic-modal.service';

@Component({
selector: 'app-test',
templateUrl: './programatic-modal.component.html',
standalone: true,
imports: [IonButton]
})
export class ProgramaticModalComponent {
constructor(private modalService: ProgramaticModalService) {}

public open() {
this.modalService.open();
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { inject, Injectable } from '@angular/core';
import { ModalController } from "@ionic/angular/standalone";
import { ModalComponent } from "./modal/modal.component";

@Injectable({
providedIn: 'root'
})
export class ProgramaticModalService {
#modalController = inject(ModalController);

async open() {
const modal = await this.#modalController.create({
component: ModalComponent,
focusTrap: true,
});
await modal.present();
}
}
Loading
Oops, something went wrong.