@react-aria/test-utils 1.0.0-alpha.3 → 1.0.0-alpha.5

package/dist/menu.mjs

@@ -1,5 +1,5 @@
 import {triggerLongPress as $5d1eca18f92ad0e6$export$3a22a5a9bc0fd3b} from "./events.mjs";
-import {within as $gS6KO$within, act as $gS6KO$act, waitFor as $gS6KO$waitFor} from "@testing-library/react";
+import {act as $gS6KO$act, waitFor as $gS6KO$waitFor, within as $gS6KO$within} from "@testing-library/react";
 
 /*
  * Copyright 2024 Adobe. All rights reserved.
@@ -14,186 +14,220 @@ import {within as $gS6KO$within, act as $gS6KO$act, waitFor as $gS6KO$waitFor} f
  */ 
 
 class $74b93f0617179929$export$f73bbc9212ed861e {
-    get trigger() {
-        if (!this._trigger) throw new Error('No trigger element found for menu.');
-        return this._trigger;
+    /**
+   * Set the interaction type used by the menu tester.
+   */ setInteractionType(type) {
+        this._interactionType = type;
     }
-    get menu() {
-        let menuId = this.trigger.getAttribute('aria-controls');
-        return menuId ? document.getElementById(menuId) : undefined;
-    }
-    get options() {
-        let menu = this.menu;
-        let options = [];
-        if (menu) {
-            options = (0, $gS6KO$within)(menu).queryAllByRole('menuitem');
-            if (options.length === 0) {
-                options = (0, $gS6KO$within)(menu).queryAllByRole('menuitemradio');
-                if (options.length === 0) options = (0, $gS6KO$within)(menu).queryAllByRole('menuitemcheckbox');
+    // TODO: this has been common to select as well, maybe make select use it? Or make a generic method. Will need to make error messages generic
+    // One difference will be that it supports long press as well
+    /**
+   * Opens the menu. Defaults to using the interaction type set on the menu tester.
+   */ async open(opts = {}) {
+        let { needsLongPress: needsLongPress, interactionType: interactionType = this._interactionType, direction: direction } = opts;
+        let trigger = this.trigger;
+        let isDisabled = trigger.hasAttribute('disabled');
+        if (interactionType === 'mouse' || interactionType === 'touch') {
+            if (needsLongPress) {
+                if (this._advanceTimer == null) throw new Error('No advanceTimers provided for long press.');
+                let pointerType = interactionType === 'mouse' ? 'mouse' : 'touch';
+                await (0, $5d1eca18f92ad0e6$export$3a22a5a9bc0fd3b)({
+                    element: trigger,
+                    advanceTimer: this._advanceTimer,
+                    pointerOpts: {
+                        pointerType: pointerType
+                    }
+                });
+            } else if (interactionType === 'mouse') await this.user.click(trigger);
+            else await this.user.pointer({
+                target: trigger,
+                keys: '[TouchA]'
+            });
+        } else if (interactionType === 'keyboard' && !isDisabled) {
+            if (direction === 'up') {
+                (0, $gS6KO$act)(()=>trigger.focus());
+                await this.user.keyboard('[ArrowUp]');
+            } else if (direction === 'down') {
+                (0, $gS6KO$act)(()=>trigger.focus());
+                await this.user.keyboard('[ArrowDown]');
+            } else {
+                (0, $gS6KO$act)(()=>trigger.focus());
+                await this.user.keyboard('[Enter]');
             }
         }
-        return options;
+        await (0, $gS6KO$waitFor)(()=>{
+            if (trigger.getAttribute('aria-controls') == null && !isDisabled) throw new Error('No aria-controls found on menu trigger element.');
+            else return true;
+        });
+        if (!isDisabled) {
+            let menuId = trigger.getAttribute('aria-controls');
+            await (0, $gS6KO$waitFor)(()=>{
+                if (!menuId || document.getElementById(menuId) == null) throw new Error(`Menu with id of ${menuId} not found in document.`);
+                else return true;
+            });
+        }
     }
-    get sections() {
+    /**
+   * Returns a option matching the specified index or text content.
+   */ findOption(opts) {
+        let { optionIndexOrText: optionIndexOrText } = opts;
+        let option;
+        let options = this.options();
         let menu = this.menu;
-        if (menu) return (0, $gS6KO$within)(menu).queryAllByRole('group');
-        else return [];
-    }
-    get submenuTriggers() {
-        let options = this.options;
-        if (options.length > 0) return this.options.filter((item)=>item.getAttribute('aria-haspopup') != null);
-        return [];
+        if (typeof optionIndexOrText === 'number') option = options[optionIndexOrText];
+        else if (typeof optionIndexOrText === 'string' && menu != null) option = (0, $gS6KO$within)(menu).getByText(optionIndexOrText).closest('[role=menuitem], [role=menuitemradio], [role=menuitemcheckbox]');
+        return option;
     }
-    constructor(opts){
-        this._isSubmenu = false;
-        this.setInteractionType = (type)=>{
-            this._interactionType = type;
-        };
-        // TODO: this has been common to select as well, maybe make select use it? Or make a generic method. Will need to make error messages generic
-        // One difference will be that it supports long press as well
-        this.open = async (opts = {})=>{
-            let { needsLongPress: needsLongPress, interactionType: interactionType = this._interactionType, direction: direction } = opts;
-            let trigger = this.trigger;
-            let isDisabled = trigger.hasAttribute('disabled');
-            if (interactionType === 'mouse' || interactionType === 'touch') {
-                if (needsLongPress) {
-                    if (this._advanceTimer == null) throw new Error('No advanceTimers provided for long press.');
-                    let pointerType = interactionType === 'mouse' ? 'mouse' : 'touch';
-                    await (0, $5d1eca18f92ad0e6$export$3a22a5a9bc0fd3b)({
-                        element: trigger,
-                        advanceTimer: this._advanceTimer,
-                        pointerOpts: {
-                            pointerType: pointerType
-                        }
-                    });
-                } else if (interactionType === 'mouse') await this.user.click(trigger);
-                else await this.user.pointer({
-                    target: trigger,
-                    keys: '[TouchA]'
+    // TODO: also very similar to select, barring potential long press support
+    // Close on select is also kinda specific?
+    /**
+   * Selects the desired menu option. Defaults to using the interaction type set on the menu tester. If necessary, will open the menu dropdown beforehand.
+   * The desired option can be targeted via the option's node, the option's text, or the option's index.
+   */ async selectOption(opts) {
+        let { menuSelectionMode: menuSelectionMode = 'single', needsLongPress: needsLongPress, closesOnSelect: closesOnSelect = true, option: option, interactionType: interactionType = this._interactionType, keyboardActivation: keyboardActivation = 'Enter' } = opts;
+        let trigger = this.trigger;
+        if (!trigger.getAttribute('aria-controls') && !trigger.hasAttribute('aria-expanded')) await this.open({
+            needsLongPress: needsLongPress
+        });
+        let menu = this.menu;
+        if (!menu) throw new Error('Menu not found.');
+        if (menu) {
+            if (typeof option === 'string' || typeof option === 'number') option = this.findOption({
+                optionIndexOrText: option
+            });
+            if (!option) throw new Error('Target option not found in the menu.');
+            if (interactionType === 'keyboard') {
+                if ((option === null || option === void 0 ? void 0 : option.getAttribute('aria-disabled')) === 'true') return;
+                if (document.activeElement !== menu || !menu.contains(document.activeElement)) (0, $gS6KO$act)(()=>menu.focus());
+                await this.keyboardNavigateToOption({
+                    option: option
                 });
-            } else if (interactionType === 'keyboard' && !isDisabled) {
-                if (direction === 'up') {
-                    (0, $gS6KO$act)(()=>trigger.focus());
-                    await this.user.keyboard('[ArrowUp]');
-                } else if (direction === 'down') {
-                    (0, $gS6KO$act)(()=>trigger.focus());
-                    await this.user.keyboard('[ArrowDown]');
-                } else {
-                    (0, $gS6KO$act)(()=>trigger.focus());
-                    await this.user.keyboard('[Enter]');
-                }
-            }
-            await (0, $gS6KO$waitFor)(()=>{
-                if (trigger.getAttribute('aria-controls') == null && !isDisabled) throw new Error('No aria-controls found on menu trigger element.');
-                else return true;
+                await this.user.keyboard(`[${keyboardActivation}]`);
+            } else if (interactionType === 'mouse') await this.user.click(option);
+            else await this.user.pointer({
+                target: option,
+                keys: '[TouchA]'
+            });
+            (0, $gS6KO$act)(()=>{
+                jest.runAllTimers();
             });
-            if (!isDisabled) {
-                let menuId = trigger.getAttribute('aria-controls');
+            if (option.getAttribute('href') == null && option.getAttribute('aria-haspopup') == null && menuSelectionMode === 'single' && closesOnSelect && keyboardActivation !== 'Space' && !this._isSubmenu) {
                 await (0, $gS6KO$waitFor)(()=>{
-                    if (!menuId || document.getElementById(menuId) == null) throw new Error(`Menu with id of ${menuId} not found in document.`);
+                    if (document.activeElement !== trigger) throw new Error(`Expected the document.activeElement after selecting an option to be the menu trigger but got ${document.activeElement}`);
                     else return true;
                 });
+                if (document.contains(menu)) throw new Error('Expected menu element to not be in the document after selecting an option');
             }
-        };
-        // TODO: also very similar to select, barring potential long press support
-        // Close on select is also kinda specific?
-        this.selectOption = async (opts)=>{
-            let { optionText: optionText, menuSelectionMode: menuSelectionMode = 'single', needsLongPress: needsLongPress, closesOnSelect: closesOnSelect = true, option: option, interactionType: interactionType = this._interactionType, keyboardActivation: keyboardActivation = 'Enter' } = opts;
-            let trigger = this.trigger;
-            if (!trigger.getAttribute('aria-controls') && !trigger.hasAttribute('aria-expanded')) await this.open({
-                needsLongPress: needsLongPress
-            });
+        } else throw new Error("Attempted to select a option in the menu, but menu wasn't found.");
+    }
+    // TODO: update this to remove needsLongPress if we wanna make the user call open first always
+    /**
+   * Opens the submenu. Defaults to using the interaction type set on the menu tester. The submenu trigger can be targeted via the trigger's node or the trigger's text.
+   */ async openSubmenu(opts) {
+        let { submenuTrigger: submenuTrigger, needsLongPress: needsLongPress, interactionType: interactionType = this._interactionType } = opts;
+        let trigger = this.trigger;
+        let isDisabled = trigger.hasAttribute('disabled');
+        if (!trigger.getAttribute('aria-controls') && !isDisabled) await this.open({
+            needsLongPress: needsLongPress
+        });
+        if (!isDisabled) {
             let menu = this.menu;
             if (menu) {
-                if (!option && optionText) option = (0, $gS6KO$within)(menu).getByText(optionText).closest('[role=menuitem], [role=menuitemradio], [role=menuitemcheckbox]');
-                if (!option) throw new Error('No option found in the menu.');
-                if (interactionType === 'keyboard') {
-                    if (document.activeElement !== menu || !menu.contains(document.activeElement)) (0, $gS6KO$act)(()=>menu.focus());
-                    await this.keyboardNavigateToOption({
-                        option: option
-                    });
-                    await this.user.keyboard(`[${keyboardActivation}]`);
-                } else if (interactionType === 'mouse') await this.user.click(option);
-                else await this.user.pointer({
-                    target: option,
-                    keys: '[TouchA]'
-                });
-                (0, $gS6KO$act)(()=>{
-                    jest.runAllTimers();
+                if (typeof submenuTrigger === 'string') submenuTrigger = (0, $gS6KO$within)(menu).getByText(submenuTrigger).closest('[role=menuitem]');
+                let submenuTriggerTester = new $74b93f0617179929$export$f73bbc9212ed861e({
+                    user: this.user,
+                    interactionType: this._interactionType,
+                    root: submenuTrigger,
+                    isSubmenu: true
                 });
-                if (option && option.getAttribute('href') == null && option.getAttribute('aria-haspopup') == null && menuSelectionMode === 'single' && closesOnSelect && keyboardActivation !== 'Space' && !this._isSubmenu) {
-                    await (0, $gS6KO$waitFor)(()=>{
-                        if (document.activeElement !== trigger) throw new Error(`Expected the document.activeElement after selecting an option to be the menu trigger but got ${document.activeElement}`);
-                        else return true;
+                if (interactionType === 'mouse') {
+                    await this.user.pointer({
+                        target: submenuTrigger
                     });
-                    if (document.contains(menu)) throw new Error('Expected menu element to not be in the document after selecting an option');
-                }
-            } else throw new Error("Attempted to select a option in the menu, but menu wasn't found.");
-        };
-        // TODO: update this to remove needsLongPress if we wanna make the user call open first always
-        this.openSubmenu = async (opts)=>{
-            let { submenuTrigger: submenuTrigger, submenuTriggerText: submenuTriggerText, needsLongPress: needsLongPress, interactionType: interactionType = this._interactionType } = opts;
-            let trigger = this.trigger;
-            let isDisabled = trigger.hasAttribute('disabled');
-            if (!trigger.getAttribute('aria-controls') && !isDisabled) await this.open({
-                needsLongPress: needsLongPress
-            });
-            if (!isDisabled) {
-                let menu = this.menu;
-                if (menu) {
-                    let submenu;
-                    if (submenuTrigger) submenu = submenuTrigger;
-                    else if (submenuTriggerText) submenu = (0, $gS6KO$within)(menu).getByText(submenuTriggerText);
-                    let submenuTriggerTester = new $74b93f0617179929$export$f73bbc9212ed861e({
-                        user: this.user,
-                        interactionType: this._interactionType,
-                        root: submenu,
-                        isSubmenu: true
+                    (0, $gS6KO$act)(()=>{
+                        jest.runAllTimers();
                     });
-                    if (interactionType === 'mouse') {
-                        await this.user.pointer({
-                            target: submenu
-                        });
-                        (0, $gS6KO$act)(()=>{
-                            jest.runAllTimers();
-                        });
-                    } else if (interactionType === 'keyboard') {
-                        await this.keyboardNavigateToOption({
-                            option: submenu
-                        });
-                        await this.user.keyboard('[ArrowRight]');
-                        (0, $gS6KO$act)(()=>{
-                            jest.runAllTimers();
-                        });
-                    } else await submenuTriggerTester.open();
-                    return submenuTriggerTester;
-                }
+                } else if (interactionType === 'keyboard') {
+                    await this.keyboardNavigateToOption({
+                        option: submenuTrigger
+                    });
+                    await this.user.keyboard('[ArrowRight]');
+                    (0, $gS6KO$act)(()=>{
+                        jest.runAllTimers();
+                    });
+                } else await submenuTriggerTester.open();
+                return submenuTriggerTester;
             }
-            return null;
-        };
-        this.keyboardNavigateToOption = async (opts)=>{
-            let { option: option } = opts;
-            let options = this.options;
-            let targetIndex = options.indexOf(option);
-            if (targetIndex === -1) throw new Error('Option provided is not in the menu');
-            if (document.activeElement === this.menu) await this.user.keyboard('[ArrowDown]');
-            let currIndex = options.indexOf(document.activeElement);
-            if (targetIndex === -1) throw new Error('ActiveElement is not in the menu');
-            let direction = targetIndex > currIndex ? 'down' : 'up';
-            for(let i = 0; i < Math.abs(targetIndex - currIndex); i++)await this.user.keyboard(`[${direction === 'down' ? 'ArrowDown' : 'ArrowUp'}]`);
-        };
-        this.close = async ()=>{
-            let menu = this.menu;
-            if (menu) {
-                (0, $gS6KO$act)(()=>menu.focus());
-                await this.user.keyboard('[Escape]');
-                await (0, $gS6KO$waitFor)(()=>{
-                    if (document.activeElement !== this.trigger) throw new Error(`Expected the document.activeElement after closing the menu to be the menu trigger but got ${document.activeElement}`);
-                    else return true;
-                });
-                if (document.contains(menu)) throw new Error('Expected the menu to not be in the document after closing it.');
+        }
+        return null;
+    }
+    async keyboardNavigateToOption(opts) {
+        let { option: option } = opts;
+        let options = this.options();
+        let targetIndex = options.findIndex((opt)=>opt === option || opt.contains(option));
+        if (targetIndex === -1) throw new Error('Option provided is not in the menu');
+        if (document.activeElement === this.menu) await this.user.keyboard('[ArrowDown]');
+        let currIndex = options.indexOf(document.activeElement);
+        if (currIndex === -1) throw new Error('ActiveElement is not in the menu');
+        let direction = targetIndex > currIndex ? 'down' : 'up';
+        for(let i = 0; i < Math.abs(targetIndex - currIndex); i++)await this.user.keyboard(`[${direction === 'down' ? 'ArrowDown' : 'ArrowUp'}]`);
+    }
+    /**
+   * Closes the menu.
+   */ async close() {
+        let menu = this.menu;
+        if (menu) {
+            (0, $gS6KO$act)(()=>menu.focus());
+            await this.user.keyboard('[Escape]');
+            await (0, $gS6KO$waitFor)(()=>{
+                if (document.activeElement !== this.trigger) throw new Error(`Expected the document.activeElement after closing the menu to be the menu trigger but got ${document.activeElement}`);
+                else return true;
+            });
+            if (document.contains(menu)) throw new Error('Expected the menu to not be in the document after closing it.');
+        }
+    }
+    /**
+   * Returns the menu's trigger.
+   */ get trigger() {
+        if (!this._trigger) throw new Error('No trigger element found for menu.');
+        return this._trigger;
+    }
+    /**
+   * Returns the menu if present.
+   */ get menu() {
+        let menuId = this.trigger.getAttribute('aria-controls');
+        return menuId ? document.getElementById(menuId) : null;
+    }
+    /**
+   * Returns the menu's sections if any.
+   */ get sections() {
+        let menu = this.menu;
+        if (menu) return (0, $gS6KO$within)(menu).queryAllByRole('group');
+        else return [];
+    }
+    /**
+   * Returns the menu's options if present. Can be filtered to a subsection of the menu if provided via `element`.
+   */ options(opts = {}) {
+        let { element: element = this.menu } = opts;
+        let options = [];
+        if (element) {
+            options = (0, $gS6KO$within)(element).queryAllByRole('menuitem');
+            if (options.length === 0) {
+                options = (0, $gS6KO$within)(element).queryAllByRole('menuitemradio');
+                if (options.length === 0) options = (0, $gS6KO$within)(element).queryAllByRole('menuitemcheckbox');
             }
-        };
+        }
+        return options;
+    }
+    /**
+   * Returns the menu's submenu triggers if any.
+   */ get submenuTriggers() {
+        let options = this.options();
+        if (options.length > 0) return options.filter((item)=>item.getAttribute('aria-haspopup') != null);
+        return [];
+    }
+    constructor(opts){
+        this._isSubmenu = false;
         let { root: root, user: user, interactionType: interactionType, advanceTimer: advanceTimer, isSubmenu: isSubmenu } = opts;
         this.user = user;
         this._interactionType = interactionType || 'mouse';