Skip to content

Commit 905bd86

Browse files
committed
clarify function name
1 parent 1807b0c commit 905bd86

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

core/src/components/menu/menu.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { GESTURE_CONTROLLER } from '@utils/gesture';
66
import type { Attributes } from '@utils/helpers';
77
import { inheritAriaAttributes, assert, clamp, isEndSide as isEnd } from '@utils/helpers';
88
import { menuController } from '@utils/menu-controller';
9-
import { getOverlay } from '@utils/overlays';
9+
import { getPresentedOverlay } from '@utils/overlays';
1010

1111
import { config } from '../../global/config';
1212
import { getIonMode } from '../../global/ionic-global';
@@ -59,7 +59,7 @@ export class Menu implements ComponentInterface, MenuI {
5959
* open does not contain this ion-menu, then ion-menu's
6060
* focus trapping should not run.
6161
*/
62-
const lastOverlay = getOverlay(document);
62+
const lastOverlay = getPresentedOverlay(document);
6363
if (lastOverlay && !lastOverlay.contains(this.el)) {
6464
return;
6565
}

core/src/utils/overlays.ts

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const createController = <Opts extends object, HTMLElm>(tagName: string) => {
3838
return dismissOverlay(document, data, role, tagName, id);
3939
},
4040
async getTop(): Promise<HTMLElm | undefined> {
41-
return getOverlay(document, tagName) as any;
41+
return getPresentedOverlay(document, tagName) as any;
4242
},
4343
};
4444
};
@@ -175,7 +175,10 @@ const focusLastDescendant = (ref: Element, overlay: HTMLIonOverlayElement) => {
175175
* Should NOT include: Toast
176176
*/
177177
const trapKeyboardFocus = (ev: Event, doc: Document) => {
178-
const lastOverlay = getOverlay(doc, 'ion-alert,ion-action-sheet,ion-loading,ion-modal,ion-picker,ion-popover');
178+
const lastOverlay = getPresentedOverlay(
179+
doc,
180+
'ion-alert,ion-action-sheet,ion-loading,ion-modal,ion-picker,ion-popover'
181+
);
179182
const target = ev.target as HTMLElement | null;
180183

181184
/**
@@ -346,7 +349,7 @@ const connectListeners = (doc: Document) => {
346349

347350
// handle back-button click
348351
doc.addEventListener('ionBackButton', (ev) => {
349-
const lastOverlay = getOverlay(doc);
352+
const lastOverlay = getPresentedOverlay(doc);
350353
if (lastOverlay?.backdropDismiss) {
351354
(ev as BackButtonEvent).detail.register(OVERLAY_BACK_BUTTON_PRIORITY, () => {
352355
return lastOverlay.dismiss(undefined, BACKDROP);
@@ -357,7 +360,7 @@ const connectListeners = (doc: Document) => {
357360
// handle ESC to close overlay
358361
doc.addEventListener('keydown', (ev) => {
359362
if (ev.key === 'Escape') {
360-
const lastOverlay = getOverlay(doc);
363+
const lastOverlay = getPresentedOverlay(doc);
361364
if (lastOverlay?.backdropDismiss) {
362365
lastOverlay.dismiss(undefined, BACKDROP);
363366
}
@@ -373,7 +376,7 @@ export const dismissOverlay = (
373376
overlayTag: string,
374377
id?: string
375378
): Promise<boolean> => {
376-
const overlay = getOverlay(doc, overlayTag, id);
379+
const overlay = getPresentedOverlay(doc, overlayTag, id);
377380
if (!overlay) {
378381
return Promise.reject('overlay does not exist');
379382
}
@@ -399,13 +402,17 @@ const getPresentedOverlays = (doc: Document, overlayTag?: string): HTMLIonOverla
399402
};
400403

401404
/**
402-
* Returns an overlay element
405+
* Returns a presented overlay element.
403406
* @param doc The document to find the element within.
404407
* @param overlayTag The selector for the overlay, defaults to Ionic overlay components.
405408
* @param id The unique identifier for the overlay instance.
406409
* @returns The overlay element or `undefined` if no overlay element is found.
407410
*/
408-
export const getOverlay = (doc: Document, overlayTag?: string, id?: string): HTMLIonOverlayElement | undefined => {
411+
export const getPresentedOverlay = (
412+
doc: Document,
413+
overlayTag?: string,
414+
id?: string
415+
): HTMLIonOverlayElement | undefined => {
409416
const overlays = getPresentedOverlays(doc, overlayTag);
410417
return id === undefined ? overlays[overlays.length - 1] : overlays.find((o) => o.id === id);
411418
};

0 commit comments

Comments
 (0)