@mui/material 5.10.13 → 5.10.15

package/modern/Tooltip/Tooltip.js

@@ -21,11 +21,9 @@ import useControlled from '../utils/useControlled';
 import tooltipClasses, { getTooltipUtilityClass } from './tooltipClasses';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-
 function round(value) {
   return Math.round(value * 1e5) / 1e5;
 }
-
 const useUtilityClasses = ownerState => {
   const {
     classes,
@@ -41,7 +39,6 @@ const useUtilityClasses = ownerState => {
   };
   return composeClasses(slots, getTooltipUtilityClass, classes);
 };
-
 const TooltipPopper = styled(Popper, {
   name: 'MuiTooltip',
   slot: 'Popper',
@@ -181,9 +178,7 @@ const TooltipArrow = styled('span', {
   overflow: 'hidden',
   position: 'absolute',
   width: '1em',
-  height: '0.71em'
-  /* = width / sqrt(2) = (length of the hypotenuse) */
-  ,
+  height: '0.71em' /* = width / sqrt(2) = (length of the hypotenuse) */,
   boxSizing: 'border-box',
   color: theme.vars ? theme.vars.palette.Tooltip.bg : alpha(theme.palette.grey[700], 0.9),
   '&::before': {
@@ -202,55 +197,51 @@ export function testReset() {
   hystersisOpen = false;
   clearTimeout(hystersisTimer);
 }
-
 function composeEventHandler(handler, eventHandler) {
   return event => {
     if (eventHandler) {
       eventHandler(event);
     }
-
     handler(event);
   };
-} // TODO v6: Remove PopperComponent, PopperProps, TransitionComponent and TransitionProps.
-
+}
 
+// TODO v6: Remove PopperComponent, PopperProps, TransitionComponent and TransitionProps.
 const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
   const props = useThemeProps({
     props: inProps,
     name: 'MuiTooltip'
   });
-
   const {
-    arrow = false,
-    children,
-    components = {},
-    componentsProps = {},
-    describeChild = false,
-    disableFocusListener = false,
-    disableHoverListener = false,
-    disableInteractive: disableInteractiveProp = false,
-    disableTouchListener = false,
-    enterDelay = 100,
-    enterNextDelay = 0,
-    enterTouchDelay = 700,
-    followCursor = false,
-    id: idProp,
-    leaveDelay = 0,
-    leaveTouchDelay = 1500,
-    onClose,
-    onOpen,
-    open: openProp,
-    placement = 'bottom',
-    PopperComponent: PopperComponentProp,
-    PopperProps = {},
-    slotProps = {},
-    slots = {},
-    title,
-    TransitionComponent: TransitionComponentProp = Grow,
-    TransitionProps
-  } = props,
-        other = _objectWithoutPropertiesLoose(props, _excluded);
-
+      arrow = false,
+      children,
+      components = {},
+      componentsProps = {},
+      describeChild = false,
+      disableFocusListener = false,
+      disableHoverListener = false,
+      disableInteractive: disableInteractiveProp = false,
+      disableTouchListener = false,
+      enterDelay = 100,
+      enterNextDelay = 0,
+      enterTouchDelay = 700,
+      followCursor = false,
+      id: idProp,
+      leaveDelay = 0,
+      leaveTouchDelay = 1500,
+      onClose,
+      onOpen,
+      open: openProp,
+      placement = 'bottom',
+      PopperComponent: PopperComponentProp,
+      PopperProps = {},
+      slotProps = {},
+      slots = {},
+      title,
+      TransitionComponent: TransitionComponentProp = Grow,
+      TransitionProps
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
   const theme = useTheme();
   const isRtl = theme.direction === 'rtl';
   const [childNode, setChildNode] = React.useState();
@@ -268,20 +259,19 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
     state: 'open'
   });
   let open = openState;
-
   if (process.env.NODE_ENV !== 'production') {
     // eslint-disable-next-line react-hooks/rules-of-hooks
     const {
       current: isControlled
-    } = React.useRef(openProp !== undefined); // eslint-disable-next-line react-hooks/rules-of-hooks
+    } = React.useRef(openProp !== undefined);
 
+    // eslint-disable-next-line react-hooks/rules-of-hooks
     React.useEffect(() => {
       if (childNode && childNode.disabled && !isControlled && title !== '' && childNode.tagName.toLowerCase() === 'button') {
         console.error(['MUI: You are providing a disabled `button` child to the Tooltip component.', 'A disabled element does not fire events.', "Tooltip needs to listen to the child element's events to display the title.", '', 'Add a simple wrapper element, such as a `span`.'].join('\n'));
       }
     }, [title, childNode, isControlled]);
   }
-
   const id = useId(idProp);
   const prevUserSelect = React.useRef();
   const stopTouchInteraction = React.useCallback(() => {
@@ -289,7 +279,6 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
       document.body.style.WebkitUserSelect = prevUserSelect.current;
       prevUserSelect.current = undefined;
     }
-
     clearTimeout(touchTimer.current);
   }, []);
   React.useEffect(() => {
@@ -300,20 +289,18 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
       stopTouchInteraction();
     };
   }, [stopTouchInteraction]);
-
   const handleOpen = event => {
     clearTimeout(hystersisTimer);
-    hystersisOpen = true; // The mouseover event will trigger for every nested element in the tooltip.
+    hystersisOpen = true;
+
+    // The mouseover event will trigger for every nested element in the tooltip.
     // We can skip rerendering when the tooltip is already open.
     // We are using the mouseover event instead of the mouseenter event to fix a hide/show issue.
-
     setOpenState(true);
-
     if (onOpen && !open) {
       onOpen(event);
     }
   };
-
   const handleClose = useEventCallback(
   /**
    * @param {React.SyntheticEvent | Event} event
@@ -324,32 +311,27 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
       hystersisOpen = false;
     }, 800 + leaveDelay);
     setOpenState(false);
-
     if (onClose && open) {
       onClose(event);
     }
-
     clearTimeout(closeTimer.current);
     closeTimer.current = setTimeout(() => {
       ignoreNonTouchEvents.current = false;
     }, theme.transitions.duration.shortest);
   });
-
   const handleEnter = event => {
     if (ignoreNonTouchEvents.current && event.type !== 'touchstart') {
       return;
-    } // Remove the title ahead of time.
+    }
+
+    // Remove the title ahead of time.
     // We don't want to wait for the next render commit.
     // We would risk displaying two tooltips at the same time (native + this one).
-
-
     if (childNode) {
       childNode.removeAttribute('title');
     }
-
     clearTimeout(enterTimer.current);
     clearTimeout(leaveTimer.current);
-
     if (enterDelay || hystersisOpen && enterNextDelay) {
       enterTimer.current = setTimeout(() => {
         handleOpen(event);
@@ -358,7 +340,6 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
       handleOpen(event);
     }
   };
-
   const handleLeave = event => {
     clearTimeout(enterTimer.current);
     clearTimeout(leaveTimer.current);
@@ -366,26 +347,22 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
       handleClose(event);
     }, leaveDelay);
   };
-
   const {
     isFocusVisibleRef,
     onBlur: handleBlurVisible,
     onFocus: handleFocusVisible,
     ref: focusVisibleRef
-  } = useIsFocusVisible(); // We don't necessarily care about the focusVisible state (which is safe to access via ref anyway).
+  } = useIsFocusVisible();
+  // We don't necessarily care about the focusVisible state (which is safe to access via ref anyway).
   // We just need to re-render the Tooltip if the focus-visible state changes.
-
   const [, setChildIsFocusVisible] = React.useState(false);
-
   const handleBlur = event => {
     handleBlurVisible(event);
-
     if (isFocusVisibleRef.current === false) {
       setChildIsFocusVisible(false);
       handleLeave(event);
     }
   };
-
   const handleFocus = event => {
     // Workaround for https://github.com/facebook/react/issues/7769
     // The autoFocus of React might trigger the event before the componentDidMount.
@@ -393,106 +370,89 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
     if (!childNode) {
       setChildNode(event.currentTarget);
     }
-
     handleFocusVisible(event);
-
     if (isFocusVisibleRef.current === true) {
       setChildIsFocusVisible(true);
       handleEnter(event);
     }
   };
-
   const detectTouchStart = event => {
     ignoreNonTouchEvents.current = true;
     const childrenProps = children.props;
-
     if (childrenProps.onTouchStart) {
       childrenProps.onTouchStart(event);
     }
   };
-
   const handleMouseOver = handleEnter;
   const handleMouseLeave = handleLeave;
-
   const handleTouchStart = event => {
     detectTouchStart(event);
     clearTimeout(leaveTimer.current);
     clearTimeout(closeTimer.current);
     stopTouchInteraction();
-    prevUserSelect.current = document.body.style.WebkitUserSelect; // Prevent iOS text selection on long-tap.
-
+    prevUserSelect.current = document.body.style.WebkitUserSelect;
+    // Prevent iOS text selection on long-tap.
     document.body.style.WebkitUserSelect = 'none';
     touchTimer.current = setTimeout(() => {
       document.body.style.WebkitUserSelect = prevUserSelect.current;
       handleEnter(event);
     }, enterTouchDelay);
   };
-
   const handleTouchEnd = event => {
     if (children.props.onTouchEnd) {
       children.props.onTouchEnd(event);
     }
-
     stopTouchInteraction();
     clearTimeout(leaveTimer.current);
     leaveTimer.current = setTimeout(() => {
       handleClose(event);
     }, leaveTouchDelay);
   };
-
   React.useEffect(() => {
     if (!open) {
       return undefined;
     }
+
     /**
      * @param {KeyboardEvent} nativeEvent
      */
-
-
     function handleKeyDown(nativeEvent) {
       // IE11, Edge (prior to using Bink?) use 'Esc'
       if (nativeEvent.key === 'Escape' || nativeEvent.key === 'Esc') {
         handleClose(nativeEvent);
       }
     }
-
     document.addEventListener('keydown', handleKeyDown);
     return () => {
       document.removeEventListener('keydown', handleKeyDown);
     };
   }, [handleClose, open]);
-  const handleRef = useForkRef(children.ref, focusVisibleRef, setChildNode, ref); // There is no point in displaying an empty tooltip.
+  const handleRef = useForkRef(children.ref, focusVisibleRef, setChildNode, ref);
 
+  // There is no point in displaying an empty tooltip.
   if (!title && title !== 0) {
     open = false;
   }
-
   const positionRef = React.useRef({
     x: 0,
     y: 0
   });
   const popperRef = React.useRef();
-
   const handleMouseMove = event => {
     const childrenProps = children.props;
-
     if (childrenProps.onMouseMove) {
       childrenProps.onMouseMove(event);
     }
-
     positionRef.current = {
       x: event.clientX,
       y: event.clientY
     };
-
     if (popperRef.current) {
       popperRef.current.update();
     }
   };
-
   const nameOrDescProps = {};
   const titleIsString = typeof title === 'string';
-
   if (describeChild) {
     nameOrDescProps.title = !open && titleIsString && !disableHoverListener ? title : null;
     nameOrDescProps['aria-describedby'] = open ? id : null;
@@ -500,7 +460,6 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
     nameOrDescProps['aria-label'] = titleIsString ? title : null;
     nameOrDescProps['aria-labelledby'] = open && !titleIsString ? id : null;
   }
-
   const childrenProps = _extends({}, nameOrDescProps, other, children.props, {
     className: clsx(other.className, children.props.className),
     onTouchStart: detectTouchStart,
@@ -508,50 +467,42 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
   }, followCursor ? {
     onMouseMove: handleMouseMove
   } : {});
-
   if (process.env.NODE_ENV !== 'production') {
-    childrenProps['data-mui-internal-clone-element'] = true; // eslint-disable-next-line react-hooks/rules-of-hooks
+    childrenProps['data-mui-internal-clone-element'] = true;
 
+    // eslint-disable-next-line react-hooks/rules-of-hooks
     React.useEffect(() => {
       if (childNode && !childNode.getAttribute('data-mui-internal-clone-element')) {
         console.error(['MUI: The `children` component of the Tooltip is not forwarding its props correctly.', 'Please make sure that props are spread on the same element that the ref is applied to.'].join('\n'));
       }
     }, [childNode]);
   }
-
   const interactiveWrapperListeners = {};
-
   if (!disableTouchListener) {
     childrenProps.onTouchStart = handleTouchStart;
     childrenProps.onTouchEnd = handleTouchEnd;
   }
-
   if (!disableHoverListener) {
     childrenProps.onMouseOver = composeEventHandler(handleMouseOver, childrenProps.onMouseOver);
     childrenProps.onMouseLeave = composeEventHandler(handleMouseLeave, childrenProps.onMouseLeave);
-
     if (!disableInteractive) {
       interactiveWrapperListeners.onMouseOver = handleMouseOver;
       interactiveWrapperListeners.onMouseLeave = handleMouseLeave;
     }
   }
-
   if (!disableFocusListener) {
     childrenProps.onFocus = composeEventHandler(handleFocus, childrenProps.onFocus);
     childrenProps.onBlur = composeEventHandler(handleBlur, childrenProps.onBlur);
-
     if (!disableInteractive) {
       interactiveWrapperListeners.onFocus = handleFocus;
       interactiveWrapperListeners.onBlur = handleBlur;
     }
   }
-
   if (process.env.NODE_ENV !== 'production') {
     if (children.props.title) {
       console.error(['MUI: You have provided a `title` prop to the child of <Tooltip />.', `Remove this title prop \`${children.props.title}\` or the Tooltip component.`].join('\n'));
     }
   }
-
   const popperOptions = React.useMemo(() => {
     let tooltipModifiers = [{
       name: 'arrow',
@@ -561,16 +512,13 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
         padding: 4
       }
     }];
-
     if (PopperProps.popperOptions?.modifiers) {
       tooltipModifiers = tooltipModifiers.concat(PopperProps.popperOptions.modifiers);
     }
-
     return _extends({}, PopperProps.popperOptions, {
       modifiers: tooltipModifiers
     });
   }, [arrowRef, PopperProps]);
-
   const ownerState = _extends({}, props, {
     isRtl,
     arrow,
@@ -579,7 +527,6 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
     PopperComponentProp,
     touch: ignoreNonTouchEvents.current
   });
-
   const classes = useUtilityClasses(ownerState);
   const PopperComponent = slots.popper ?? components.Popper ?? TooltipPopper;
   const TransitionComponent = slots.transition ?? components.Transition ?? TransitionComponentProp ?? Grow;
@@ -630,35 +577,28 @@ const Tooltip = /*#__PURE__*/React.forwardRef(function Tooltip(inProps, ref) {
     }))]
   });
 });
-process.env.NODE_ENV !== "production" ? Tooltip.propTypes
-/* remove-proptypes */
-= {
+process.env.NODE_ENV !== "production" ? Tooltip.propTypes /* remove-proptypes */ = {
   // ----------------------------- Warning --------------------------------
   // | These PropTypes are generated from the TypeScript type definitions |
   // |     To update them edit the d.ts file and run "yarn proptypes"     |
   // ----------------------------------------------------------------------
-
   /**
    * If `true`, adds an arrow to the tooltip.
    * @default false
    */
   arrow: PropTypes.bool,
-
   /**
    * Tooltip reference element.
    */
   children: elementAcceptingRef.isRequired,
-
   /**
    * Override or extend the styles applied to the component.
    */
   classes: PropTypes.object,
-
   /**
    * @ignore
    */
   className: PropTypes.string,
-
   /**
    * The components used for each slot inside.
    *
@@ -673,7 +613,6 @@ process.env.NODE_ENV !== "production" ? Tooltip.propTypes
     Tooltip: PropTypes.elementType,
     Transition: PropTypes.elementType
   }),
-
   /**
    * The extra props for the slot components.
    * You can override the existing props or add new ones.
@@ -689,120 +628,101 @@ process.env.NODE_ENV !== "production" ? Tooltip.propTypes
     tooltip: PropTypes.object,
     transition: PropTypes.object
   }),
-
   /**
    * Set to `true` if the `title` acts as an accessible description.
    * By default the `title` acts as an accessible label for the child.
    * @default false
    */
   describeChild: PropTypes.bool,
-
   /**
    * Do not respond to focus-visible events.
    * @default false
    */
   disableFocusListener: PropTypes.bool,
-
   /**
    * Do not respond to hover events.
    * @default false
    */
   disableHoverListener: PropTypes.bool,
-
   /**
    * Makes a tooltip not interactive, i.e. it will close when the user
    * hovers over the tooltip before the `leaveDelay` is expired.
    * @default false
    */
   disableInteractive: PropTypes.bool,
-
   /**
    * Do not respond to long press touch events.
    * @default false
    */
   disableTouchListener: PropTypes.bool,
-
   /**
    * The number of milliseconds to wait before showing the tooltip.
    * This prop won't impact the enter touch delay (`enterTouchDelay`).
    * @default 100
    */
   enterDelay: PropTypes.number,
-
   /**
    * The number of milliseconds to wait before showing the tooltip when one was already recently opened.
    * @default 0
    */
   enterNextDelay: PropTypes.number,
-
   /**
    * The number of milliseconds a user must touch the element before showing the tooltip.
    * @default 700
    */
   enterTouchDelay: PropTypes.number,
-
   /**
    * If `true`, the tooltip follow the cursor over the wrapped element.
    * @default false
    */
   followCursor: PropTypes.bool,
-
   /**
    * This prop is used to help implement the accessibility logic.
    * If you don't provide this prop. It falls back to a randomly generated id.
    */
   id: PropTypes.string,
-
   /**
    * The number of milliseconds to wait before hiding the tooltip.
    * This prop won't impact the leave touch delay (`leaveTouchDelay`).
    * @default 0
    */
   leaveDelay: PropTypes.number,
-
   /**
    * The number of milliseconds after the user stops touching an element before hiding the tooltip.
    * @default 1500
    */
   leaveTouchDelay: PropTypes.number,
-
   /**
    * Callback fired when the component requests to be closed.
    *
    * @param {React.SyntheticEvent} event The event source of the callback.
    */
   onClose: PropTypes.func,
-
   /**
    * Callback fired when the component requests to be open.
    *
    * @param {React.SyntheticEvent} event The event source of the callback.
    */
   onOpen: PropTypes.func,
-
   /**
    * If `true`, the component is shown.
    */
   open: PropTypes.bool,
-
   /**
    * Tooltip placement.
    * @default 'bottom'
    */
   placement: PropTypes.oneOf(['bottom-end', 'bottom-start', 'bottom', 'left-end', 'left-start', 'left', 'right-end', 'right-start', 'right', 'top-end', 'top-start', 'top']),
-
   /**
    * The component used for the popper.
    * @default Popper
    */
   PopperComponent: PropTypes.elementType,
-
   /**
    * Props applied to the [`Popper`](/material-ui/api/popper/) element.
    * @default {}
    */
   PopperProps: PropTypes.object,
-
   /**
    * The extra props for the slot components.
    * You can override the existing props or add new ones.
@@ -817,7 +737,6 @@ process.env.NODE_ENV !== "production" ? Tooltip.propTypes
     tooltip: PropTypes.object,
     transition: PropTypes.object
   }),
-
   /**
    * The components used for each slot inside.
    *
@@ -831,24 +750,20 @@ process.env.NODE_ENV !== "production" ? Tooltip.propTypes
     tooltip: PropTypes.elementType,
     transition: PropTypes.elementType
   }),
-
   /**
    * The system prop that allows defining system overrides as well as additional CSS styles.
    */
   sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
-
   /**
    * Tooltip title. Zero-length titles string, undefined, null and false are never displayed.
    */
   title: PropTypes.node,
-
   /**
    * The component used for the transition.
    * [Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
    * @default Grow
    */
   TransitionComponent: PropTypes.elementType,
-
   /**
    * Props applied to the transition element.
    * By default, the element is based on this [`Transition`](http://reactcommunity.org/react-transition-group/transition/) component.