ionic-framework/core/src/components/popover-controller

ion-popover-controller

Popover controllers programmatically control the popover component. Popovers can be created and dismissed from the popover controller. View the Popover documentation for a full list of options to pass upon creation.

Usage

Javascript

async function presentPopover() {
  const popoverController = document.querySelector('ion-popover-controller');
  await popoverController.componentOnReady();

  const popoverElement = await popoverController.create({
    component: 'profile-page',
    event: event
  });
  return await popoverElement.present();
}

Methods

create<T extends ComponentRef>(options: PopoverOptions<T>) => Promise<HTMLIonPopoverElement>

Create a popover overlay with popover options.

Parameters

Name	Type	Description
options	PopoverOptions<T>	The options to use to create the popover.

Returns

Type: Promise<HTMLIonPopoverElement>

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

Dismiss the open popover overlay.

Parameters

Name	Type	Description
data	any	Any data to emit in the dismiss events.
role	string | undefined	The role of the element that is dismissing the popover. This can be useful in a button handler for determining which button was clicked to dismiss the popover. Some examples include: ``"cancel", "destructive", "selected", and "backdrop".
id	string | undefined	The id of the popover to dismiss. If an id is not provided, it will dismiss the most recently opened popover.

Returns

Type: Promise<boolean>

getTop() => Promise<HTMLIonPopoverElement | undefined>

Get the most recently opened popover overlay.

Returns

Type: Promise<HTMLIonPopoverElement | undefined>

---

Built with StencilJS