ion-modal

Contents

A Modal is a dialog that appears on top of the app's content, and must be dismissed by the app before interaction can resume. It is useful as a select component when there are a lot of options to choose from, or when filtering items in a list, as well as many other use cases.

Creating

Modals can be created using a Modal Controller. They can be customized by passing modal options in the modal controller's create method.

Passing paramaters

When a modal is created, paramaters might be passed to the newly created modal:

// Create a modal using MyModalComponent with some initial data
const modal = await modalController.create({
  component: MyModalComponent,
  componentProps: {
    'prop1': value,
    'prop2': value2
  }
});

Under the hood, the controller creates a new ion-modal and attaches the specified component to it. It also assigns the specified componentProps to the component's instance:

// pseudo-code
const instance = create(MyModalComponent);
instance.prop1 = value;
instance.prop2 = value2;

This way, your component can access the passed params, check the "Usage" section for further code example for each frameworks.

Returning data

Modals can also return data back to the controller when they are dismissed.

const modal = await modalController.create({...});
const { data } = await modal.onDidDismiss();
console.log(data);
// Dismiss the top modal returning some data object
modalController.dismiss({
  'result': value
})

Usage

angular javascript
import { Component } from '@angular/core';
import { ModalController } from '@ionic/angular';
import { ModalPage } from '../modal/modal.page';
@Component({
  selector: 'modal-example',
  templateUrl: 'modal-example.html',
  styleUrls: ['./modal-example.css']
})
export class ModalExample {
  constructor(public modalController: ModalController) {}

  async presentModal() {
    const modal = await this.modalController.create({
      component: ModalPage,
      componentProps: { value: 123 }
    });
    return await modal.present();
  }
}
import { Component } from '@angular/core';
import { NavParams } from '@ionic/angular';

@Component({
  selector: 'modal-page',
})
export class ModalExample {

  // "value" passed in componentProps
  @Input() value: number;

  constructor(navParams: NavParams) {
    // componentProps can also be accessed at construction time using NavParams
  }

}
<body>
  <ion-modal-controller></ion-modal-controller>
</body>
customElements.define('modal-page', class extends HTMLElement {
  connectedCallback() {
    this.innerHTML = `
<ion-header>
  <ion-toolbar>
    <ion-title>Super Modal</ion-title>
  </ion-toolbar>
</ion-header>
<ion-content>
  Content
</ion-content>`;
  }
});

async function presentModal() {
  // initialize controller
  const modalController = document.querySelector('ion-modal-controller');
  await modalController.componentOnReady();

  // present the modal
  const modalElement = await modalController.create({
    component: 'modal-page'
  });
  await modalElement.present();
}

Properties

animated

Description

If true, the modal will animate.

Attribute animated
Type boolean

backdropDismiss

Description

If true, the modal will be dismissed when the backdrop is clicked.

Attribute backdrop-dismiss
Type boolean

component

Description

The component to display inside of the modal.

Attribute component
Type Function | HTMLElement | null | string

componentProps

Description

The data to pass to the modal component.

Type undefined | { [key: string]: any; }

cssClass

Description

Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.

Attribute css-class
Type string | string[] | undefined

enterAnimation

Description

Animation to use when the modal is presented.

Type ((Animation: Animation, baseEl: any, opts?: any) => Promise<Animation>) | undefined

keyboardClose

Description

If true, the keyboard will be automatically dismissed when the overlay is presented.

Attribute keyboard-close
Type boolean

leaveAnimation

Description

Animation to use when the modal is dismissed.

Type ((Animation: Animation, baseEl: any, opts?: any) => Promise<Animation>) | undefined

mode

Description

The mode determines which platform styles to use.

Attribute mode
Type "ios" | "md"

showBackdrop

Description

If true, a backdrop will be displayed behind the modal.

Attribute show-backdrop
Type boolean

Events

Name Description
ionModalDidDismiss Emitted after the modal has dismissed.
ionModalDidPresent Emitted after the modal has presented.
ionModalWillDismiss Emitted before the modal has dismissed.
ionModalWillPresent Emitted before the modal has presented.

Methods

dismiss

Description

Dismiss the modal overlay after it has been presented.

Signature dismiss(data?: any, role?: string | undefined) => Promise<boolean>

onDidDismiss

Description

Returns a promise that resolves when the modal did dismiss.

Signature onDidDismiss() => Promise<OverlayEventDetail<any>>

onWillDismiss

Description

Returns a promise that resolves when the modal will dismiss.

Signature onWillDismiss() => Promise<OverlayEventDetail<any>>

present

Description

Present the modal overlay after it has been created.

Signature present() => Promise<void>

CSS Custom Properties

Name Description
--background Background of the modal content
--border-color Border color of the modal content
--border-radius Border radius of the modal content
--border-style Border style of the modal content
--border-width Border width of the modal content
--height Height of the modal
--max-height Maximum height of the modal
--max-width Maximum width of the modal
--min-height Minimum height of the modal
--min-width Minimum width of the modal
--width Width of the modal