@mui/material 9.0.0 → 9.1.0

package/Select/SelectInput.js

@@ -15,19 +15,59 @@ var _clsx = _interopRequireDefault(require("clsx"));
 var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
 var _useId = _interopRequireDefault(require("@mui/utils/useId"));
 var _refType = _interopRequireDefault(require("@mui/utils/refType"));
+var _useTimeout = _interopRequireDefault(require("@mui/utils/useTimeout"));
 var _ownerDocument = _interopRequireDefault(require("../utils/ownerDocument"));
 var _Menu = _interopRequireDefault(require("../Menu/Menu"));
 var _NativeSelectInput = require("../NativeSelect/NativeSelectInput");
 var _utils = require("../InputBase/utils");
 var _zeroStyled = require("../zero-styled");
 var _slotShouldForwardProp = _interopRequireDefault(require("../styles/slotShouldForwardProp"));
+var _useEnhancedEffect = _interopRequireDefault(require("../utils/useEnhancedEffect"));
+var _useEventCallback = _interopRequireDefault(require("../utils/useEventCallback"));
 var _useForkRef = _interopRequireDefault(require("../utils/useForkRef"));
 var _useControlled = _interopRequireDefault(require("../utils/useControlled"));
 var _selectClasses = _interopRequireWildcard(require("./selectClasses"));
 var _utils2 = require("./utils");
+var _closedTypeahead = require("./utils/closedTypeahead");
 var _SelectFocusSourceContext = require("./utils/SelectFocusSourceContext");
 var _jsxRuntime = require("react/jsx-runtime");
 var _span;
+const OPENING_MOUSE_UP_BOUNDARY_OFFSET = 2;
+// The initial mouseup may land on an item when the menu opens over the trigger.
+const SELECTED_MOUSE_UP_DELAY = 400;
+const UNSELECTED_MOUSE_UP_DELAY = 200;
+const TYPEAHEAD_RESET_MS = 750;
+const SPACE = ' ';
+const ARROW_UP = 'ArrowUp';
+const ARROW_DOWN = 'ArrowDown';
+const ENTER = 'Enter';
+
+/**
+ * Returns true when a native mouse event should be treated as happening inside
+ * the element, even if a portal or backdrop retargeted the event away from it.
+ *
+ * Select uses this for the opening mouseup: when the menu opens over the
+ * trigger, the release can target the backdrop or portaled menu even though the
+ * pointer is still inside the trigger or menu bounds.
+ */
+function isMouseEventInsideElement(event, element) {
+  if (!element) {
+    return false;
+  }
+  const eventPath = event.composedPath();
+  if (eventPath.includes(element)) {
+    return true;
+  }
+  if (event.target?.nodeType && element.contains(event.target)) {
+    return true;
+  }
+  const rect = element.getBoundingClientRect();
+  if (rect.width === 0 && rect.height === 0) {
+    // Hidden or transition-mounted elements do not have useful bounds to hit-test.
+    return false;
+  }
+  return event.clientX >= rect.left - OPENING_MOUSE_UP_BOUNDARY_OFFSET && event.clientX <= rect.right + OPENING_MOUSE_UP_BOUNDARY_OFFSET && event.clientY >= rect.top - OPENING_MOUSE_UP_BOUNDARY_OFFSET && event.clientY <= rect.bottom + OPENING_MOUSE_UP_BOUNDARY_OFFSET;
+}
 const SelectSelect = (0, _zeroStyled.styled)(_NativeSelectInput.StyledSelectSelect, {
   name: 'MuiSelect',
   slot: 'Select',
@@ -154,6 +194,23 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
   });
   const inputRef = React.useRef(null);
   const displayRef = React.useRef(null);
+  const paperRef = React.useRef(null);
+  const openRef = React.useRef(false);
+  const hasSelectedItemInListRef = React.useRef(false);
+  const openingMouseUpListenerCleanupRef = React.useRef(null);
+  const didPointerDownOnItemRef = React.useRef(false);
+  const selectionRef = React.useRef({
+    allowSelectedMouseUp: false,
+    allowUnselectedMouseUp: false
+  });
+  const closedTypeaheadRef = React.useRef({
+    buffer: '',
+    previousSearchIndex: null,
+    matchedIndex: null
+  });
+  const selectedMouseUpTimer = (0, _useTimeout.default)();
+  const unselectedMouseUpTimer = (0, _useTimeout.default)();
+  const typeaheadResetTimer = (0, _useTimeout.default)();
   const [displayNode, setDisplayNode] = React.useState(null);
   const {
     current: isOpenControlled
@@ -176,6 +233,52 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
     value
   }), [value]);
   const open = displayNode !== null && openState;
+  const resetClosedTypeahead = React.useCallback(() => {
+    typeaheadResetTimer.clear();
+    closedTypeaheadRef.current.buffer = '';
+    closedTypeaheadRef.current.previousSearchIndex = null;
+    closedTypeaheadRef.current.matchedIndex = null;
+  }, [typeaheadResetTimer]);
+  (0, _useEnhancedEffect.default)(() => {
+    openRef.current = open;
+    if (open) {
+      resetClosedTypeahead();
+    }
+  }, [open, resetClosedTypeahead]);
+  const clearSelectionTimers = React.useCallback(() => {
+    selectedMouseUpTimer.clear();
+    unselectedMouseUpTimer.clear();
+  }, [selectedMouseUpTimer, unselectedMouseUpTimer]);
+  const resetMouseUpSelection = React.useCallback(() => {
+    clearSelectionTimers();
+    didPointerDownOnItemRef.current = false;
+    selectionRef.current = {
+      allowSelectedMouseUp: false,
+      allowUnselectedMouseUp: false
+    };
+  }, [clearSelectionTimers]);
+  const clearOpeningMouseUpListener = React.useCallback(() => {
+    if (openingMouseUpListenerCleanupRef.current) {
+      openingMouseUpListenerCleanupRef.current();
+      openingMouseUpListenerCleanupRef.current = null;
+    }
+  }, []);
+  React.useEffect(() => {
+    if (!open) {
+      resetMouseUpSelection();
+      clearOpeningMouseUpListener();
+    }
+  }, [open, resetMouseUpSelection, clearOpeningMouseUpListener]);
+
+  // Keep unmount cleanup separate from the `open` effect. Effect cleanups also run
+  // before the next effect, which would clear the opening mouseup listener while opening.
+  React.useEffect(() => {
+    return () => {
+      resetMouseUpSelection();
+      clearOpeningMouseUpListener();
+      resetClosedTypeahead();
+    };
+  }, [resetMouseUpSelection, clearOpeningMouseUpListener, resetClosedTypeahead]);
   React.useEffect(() => {
     if (!open || !anchorElement || autoWidth) {
       return undefined;
@@ -226,8 +329,13 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
     }
     return undefined;
   }, [labelId]);
-  const update = (openParam, event) => {
+  const update = (0, _useEventCallback.default)((openParam, event) => {
+    if (!openParam) {
+      resetMouseUpSelection();
+      clearOpeningMouseUpListener();
+    }
     if (openParam) {
+      resetClosedTypeahead();
       setOpenInteractionType((0, _utils2.getOpenInteractionType)(event));
       if (onOpen) {
         onOpen(event);
@@ -239,9 +347,33 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       }
     }
     if (!isOpenControlled) {
+      openRef.current = openParam;
       setMenuMinWidthState(autoWidth ? null : anchorElement.clientWidth);
       setOpenState(openParam);
     }
+  });
+  const scheduleMouseUpSelection = () => {
+    resetMouseUpSelection();
+
+    // When there is no selected item in the list, a mousedown
+    // on the trigger followed by a quick mouseup over the first option can accidentally select
+    // within 200ms. Delay unselected mouseup to match the safer 400ms window.
+    if (!hasSelectedItemInListRef.current) {
+      selectedMouseUpTimer.start(SELECTED_MOUSE_UP_DELAY, () => {
+        selectionRef.current.allowSelectedMouseUp = true;
+        selectionRef.current.allowUnselectedMouseUp = true;
+      });
+    } else {
+      // mousedown -> move to unselected item -> mouseup should not select within 200ms.
+      unselectedMouseUpTimer.start(UNSELECTED_MOUSE_UP_DELAY, () => {
+        selectionRef.current.allowUnselectedMouseUp = true;
+
+        // mousedown -> mouseup on selected item should not select within 400ms.
+        selectedMouseUpTimer.start(UNSELECTED_MOUSE_UP_DELAY, () => {
+          selectionRef.current.allowSelectedMouseUp = true;
+        });
+      });
+    }
   };
   const handleMouseDown = event => {
     onMouseDown?.(event);
@@ -252,6 +384,29 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
     // Hijack the default focus behavior.
     event.preventDefault();
     displayRef.current.focus();
+    const doc = (0, _ownerDocument.default)(event.currentTarget);
+    scheduleMouseUpSelection();
+    clearOpeningMouseUpListener();
+    const handleMouseUp = mouseEvent => {
+      openingMouseUpListenerCleanupRef.current = null;
+      if (!displayRef.current) {
+        return;
+      }
+      if (isMouseEventInsideElement(mouseEvent, displayRef.current) || isMouseEventInsideElement(mouseEvent, paperRef.current)) {
+        return;
+      }
+      if (!openRef.current && isOpenControlled) {
+        return;
+      }
+      update(false, mouseEvent);
+    };
+    doc.addEventListener('mouseup', handleMouseUp, {
+      capture: true,
+      once: true
+    });
+    openingMouseUpListenerCleanupRef.current = () => {
+      doc.removeEventListener('mouseup', handleMouseUp, true);
+    };
     update(true, event);
   };
   const handleClose = event => {
@@ -270,7 +425,27 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       onChange(event, child);
     }
   };
+  const handleValueChange = (event, child, newValue) => {
+    setValueState(newValue);
+    if (onChange) {
+      // Redefine target to allow name and value to be read.
+      // This allows seamless integration with the most popular form libraries.
+      // https://github.com/mui/material-ui/issues/13485#issuecomment-676048492
+      // Clone the event to not override `target` of the original event.
+      const nativeEvent = event.nativeEvent || event;
+      const clonedEvent = new nativeEvent.constructor(nativeEvent.type, nativeEvent);
+      Object.defineProperty(clonedEvent, 'target', {
+        writable: true,
+        value: {
+          value: newValue,
+          name
+        }
+      });
+      onChange(clonedEvent, child);
+    }
+  };
   const handleItemClick = child => event => {
+    didPointerDownOnItemRef.current = false;
     let newValue;
 
     // We use the tabindex attribute to signal the available options.
@@ -292,35 +467,76 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       child.props.onClick(event);
     }
     if (value !== newValue) {
-      setValueState(newValue);
-      if (onChange) {
-        // Redefine target to allow name and value to be read.
-        // This allows seamless integration with the most popular form libraries.
-        // https://github.com/mui/material-ui/issues/13485#issuecomment-676048492
-        // Clone the event to not override `target` of the original event.
-        const nativeEvent = event.nativeEvent || event;
-        const clonedEvent = new nativeEvent.constructor(nativeEvent.type, nativeEvent);
-        Object.defineProperty(clonedEvent, 'target', {
-          writable: true,
-          value: {
-            value: newValue,
-            name
-          }
-        });
-        onChange(clonedEvent, child);
-      }
+      handleValueChange(event, child, newValue);
     }
     if (!multiple) {
       update(false, event);
     }
   };
+  const handleItemMouseUp = (child, selected) => event => {
+    child.props.onMouseUp?.(event);
+    if (didPointerDownOnItemRef.current) {
+      didPointerDownOnItemRef.current = false;
+      return;
+    }
+    const disallowSelectedMouseUp = !selectionRef.current.allowSelectedMouseUp && selected;
+    const disallowUnselectedMouseUp = !selectionRef.current.allowUnselectedMouseUp && !selected;
+    if (disallowSelectedMouseUp || disallowUnselectedMouseUp) {
+      return;
+    }
+    event.currentTarget.click();
+  };
+  const handleClosedTypeahead = event => {
+    const state = closedTypeaheadRef.current;
+    const hasActiveBuffer = state.buffer !== '';
+    if (open || multiple || disabled || event.defaultPrevented || event.nativeEvent?.isComposing || event.key.length !== 1 || event.ctrlKey || event.metaKey || event.altKey || event.key === SPACE && !hasActiveBuffer) {
+      return false;
+    }
+    if (event.key === SPACE) {
+      event.preventDefault();
+    }
+    const isNewSession = state.buffer === '';
+    const {
+      options: searchableOptions,
+      selectedIndex
+    } = (0, _closedTypeahead.getTypeaheadOptions)(childrenArray, value);
+    if (searchableOptions.length === 0) {
+      if (event.key !== SPACE) {
+        resetClosedTypeahead();
+      }
+      return true;
+    }
+    if (isNewSession) {
+      state.previousSearchIndex = selectedIndex;
+    }
+    const key = event.key.toLowerCase();
+    if (state.buffer === key && (0, _closedTypeahead.canCycleRepeatedCharacter)(searchableOptions, key)) {
+      state.buffer = '';
+      state.previousSearchIndex = state.matchedIndex;
+    }
+    state.buffer += key;
+    typeaheadResetTimer.start(TYPEAHEAD_RESET_MS, resetClosedTypeahead);
+    const matchingIndex = (0, _closedTypeahead.getMatchingOptionIndex)(searchableOptions, state.buffer, (state.previousSearchIndex ?? -1) + 1);
+    if (matchingIndex !== -1) {
+      const matchedOption = searchableOptions[matchingIndex];
+      state.matchedIndex = matchingIndex;
+      if (!(0, _utils2.areEqualValues)(value, matchedOption.value)) {
+        handleValueChange(event, matchedOption.child, matchedOption.value);
+      }
+      return true;
+    }
+    if (event.key !== SPACE) {
+      resetClosedTypeahead();
+    }
+    return true;
+  };
   const handleKeyDown = event => {
     if (!readOnly) {
-      const validKeys = [' ', 'ArrowUp', 'ArrowDown',
-      // The native select doesn't respond to enter on macOS, but it's recommended by
+      const isClosedTypeaheadHandled = handleClosedTypeahead(event);
+      // The native select doesn't respond to Enter on macOS, but it's recommended by
       // https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/
-      'Enter'];
-      if (validKeys.includes(event.key)) {
+      const isOpenKey = event.key === SPACE || event.key === ARROW_UP || event.key === ARROW_DOWN || event.key === ENTER;
+      if (!isClosedTypeaheadHandled && isOpenKey) {
         event.preventDefault();
         update(true, event);
       }
@@ -328,6 +544,7 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
     }
   };
   const handleBlur = event => {
+    resetClosedTypeahead();
     // if open event.stopImmediatePropagation
     if (!open && onBlur) {
       // Preact support, target is read only property on a native event.
@@ -341,6 +558,19 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       onBlur(event);
     }
   };
+  const handleItemKeyDown = child => event => {
+    child?.props?.onKeyDown?.(event);
+    if (event.key === SPACE && event.target === event.currentTarget && !event.defaultPrevented) {
+      // Prevent the browser from scrolling the page
+      event.preventDefault();
+      // Ignore auto-repeated keydowns to avoid toggling multiple times
+      if (!event.repeat) {
+        // Trigger via click so that onClick receives a click event,
+        // consistent with Enter and pointer interactions.
+        event.currentTarget.click();
+      }
+    }
+  };
   delete other['aria-invalid'];
   let display;
   let displaySingle;
@@ -387,9 +617,18 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
     }
     return /*#__PURE__*/React.cloneElement(child, {
       'aria-selected': selected ? 'true' : 'false',
+      onMouseDown: event => {
+        didPointerDownOnItemRef.current = true;
+        child.props.onMouseDown?.(event);
+      },
+      onPointerDown: event => {
+        didPointerDownOnItemRef.current = true;
+        child.props.onPointerDown?.(event);
+      },
       onClick: handleItemClick(child),
+      onMouseUp: handleItemMouseUp(child, selected),
       onKeyUp: event => {
-        if (event.key === ' ') {
+        if (event.key === SPACE) {
           // otherwise our MenuItems dispatches a click event
           // it's not behavior of the native <option> and causes
           // the select to close immediately since we open on space keydown
@@ -399,6 +638,7 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
           child.props.onKeyUp(event);
         }
       },
+      onKeyDown: handleItemKeyDown(child),
       role: 'option',
       selected,
       value: undefined,
@@ -406,6 +646,14 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       'data-value': child.props.value // Instead, we provide it as a data attribute.
     });
   });
+
+  // Keep the opening mouseup guard current without mutating refs during render.
+  (0, _useEnhancedEffect.default)(() => {
+    hasSelectedItemInListRef.current = foundMatch;
+    if (!open && !multiple && !foundMatch) {
+      resetClosedTypeahead();
+    }
+  }, [foundMatch, multiple, open, resetClosedTypeahead]);
   if (process.env.NODE_ENV !== 'production') {
     // TODO: uncomment once we enable eslint-plugin-react-compiler // eslint-disable-next-line react-compiler/react-compiler
     // eslint-disable-next-line react-hooks/rules-of-hooks
@@ -455,6 +703,7 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
   };
   const classes = useUtilityClasses(ownerState);
   const menuPaperSlotProps = typeof MenuProps.slotProps?.paper === 'function' ? MenuProps.slotProps.paper(ownerState) : MenuProps.slotProps?.paper;
+  const handlePaperRef = (0, _useForkRef.default)(menuPaperSlotProps?.ref, paperRef);
   const menuListSlotProps = typeof MenuProps.slotProps?.list === 'function' ? MenuProps.slotProps.list(ownerState) : MenuProps.slotProps?.list;
   const listboxId = (0, _useId.default)();
   const nativeInputId = (0, _useId.default)();
@@ -468,8 +717,9 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       "aria-disabled": disabled ? 'true' : undefined,
       "aria-expanded": open ? 'true' : 'false',
       "aria-haspopup": "listbox",
+      "aria-readonly": readOnly ? 'true' : undefined,
       "aria-label": ariaLabel,
-      "aria-labelledby": [labelId, buttonId].filter(Boolean).join(' ') || undefined,
+      "aria-labelledby": labelId,
       "aria-describedby": ariaDescribedby,
       "aria-required": required ? 'true' : undefined,
       "aria-invalid": error ? 'true' : undefined,
@@ -498,6 +748,7 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
       onChange: handleChange,
       tabIndex: -1,
       disabled: disabled,
+      readOnly: readOnly,
       className: classes.nativeInput,
       autoFocus: autoFocus,
       required: required,
@@ -536,6 +787,7 @@ const SelectInput = /*#__PURE__*/React.forwardRef(function SelectInput(props, re
           },
           paper: {
             ...menuPaperSlotProps,
+            ref: handlePaperRef,
             style: {
               minWidth: menuMinWidth,
               ...menuPaperSlotProps?.style