react-tooltip 5.22.0-beta.1109.0 → 5.22.0

package/dist/react-tooltip.mjs

@@ -5,7 +5,7 @@
 * @copyright ReactTooltip Team
 * @license MIT
 */
-import React, { createContext, useState, useCallback, useMemo, useContext, useRef, useEffect, useLayoutEffect, useImperativeHandle } from 'react';
+import React, { createContext, useState, useCallback, useMemo, useContext, useRef, useEffect, useLayoutEffect } from 'react';
 import { arrow, computePosition, offset, flip, shift, autoUpdate } from '@floating-ui/dom';
 import classNames from 'classnames';
 
@@ -318,16 +318,15 @@ const computeTooltipPosition = async ({ elementReference = null, tooltipReferenc
     });
 };
 
-var coreStyles = {"tooltip":"core-styles-module_tooltip__3vRRp","fixed":"core-styles-module_fixed__pcSol","arrow":"core-styles-module_arrow__cvMwQ","noArrow":"core-styles-module_noArrow__xock6","clickable":"core-styles-module_clickable__ZuTTB","show":"core-styles-module_show__Nt9eE"};
+var coreStyles = {"tooltip":"core-styles-module_tooltip__3vRRp","fixed":"core-styles-module_fixed__pcSol","arrow":"core-styles-module_arrow__cvMwQ","noArrow":"core-styles-module_noArrow__xock6","clickable":"core-styles-module_clickable__ZuTTB","show":"core-styles-module_show__Nt9eE","closing":"core-styles-module_closing__sGnxF"};
 
 var styles = {"tooltip":"styles-module_tooltip__mnnfp","arrow":"styles-module_arrow__K0L3T","dark":"styles-module_dark__xNqje","light":"styles-module_light__Z6W-X","success":"styles-module_success__A2AKt","warning":"styles-module_warning__SCK0X","error":"styles-module_error__JvumD","info":"styles-module_info__BWdHW"};
 
 const Tooltip = ({ 
 // props
-forwardRef, id, className, classNameArrow, variant = 'dark', anchorId, anchorSelect, place = 'top', offset = 10, events = ['hover'], openOnClick = false, positionStrategy = 'absolute', middlewares, wrapper: WrapperElement, delayShow = 0, delayHide = 0, float = false, hidden = false, noArrow = false, clickable = false, closeOnEsc = false, closeOnScroll = false, closeOnResize = false, style: externalStyles, position, afterShow, afterHide, 
+id, className, classNameArrow, variant = 'dark', anchorId, anchorSelect, place = 'top', offset = 10, events = ['hover'], openOnClick = false, positionStrategy = 'absolute', middlewares, wrapper: WrapperElement, delayShow = 0, delayHide = 0, float = false, hidden = false, noArrow = false, clickable = false, closeOnEsc = false, closeOnScroll = false, closeOnResize = false, openEvents, closeEvents, globalCloseEvents, style: externalStyles, position, afterShow, afterHide, 
 // props handled by controller
 content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, border, opacity, arrowColor, }) => {
-    var _a;
     const tooltipRef = useRef(null);
     const tooltipArrowRef = useRef(null);
     const tooltipShowDelayTimerRef = useRef(null);
@@ -337,7 +336,6 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
     const [inlineArrowStyles, setInlineArrowStyles] = useState({});
     const [show, setShow] = useState(false);
     const [rendered, setRendered] = useState(false);
-    const [imperativeOptions, setImperativeOptions] = useState(null);
     const wasShowing = useRef(false);
     const lastFloatPosition = useRef(null);
     /**
@@ -347,7 +345,48 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
     const hoveringTooltip = useRef(false);
     const [anchorsBySelect, setAnchorsBySelect] = useState([]);
     const mounted = useRef(false);
+    /**
+     * @todo Update when deprecated stuff gets removed.
+     */
     const shouldOpenOnClick = openOnClick || events.includes('click');
+    const hasClickEvent = shouldOpenOnClick || (openEvents === null || openEvents === void 0 ? void 0 : openEvents.click) || (openEvents === null || openEvents === void 0 ? void 0 : openEvents.dblclick) || (openEvents === null || openEvents === void 0 ? void 0 : openEvents.mousedown);
+    const actualOpenEvents = openEvents
+        ? { ...openEvents }
+        : {
+            mouseenter: true,
+            focus: true,
+            click: false,
+            dblclick: false,
+            mousedown: false,
+        };
+    if (!openEvents && shouldOpenOnClick) {
+        Object.assign(actualOpenEvents, {
+            mouseenter: false,
+            focus: false,
+            click: true,
+        });
+    }
+    const actualCloseEvents = closeEvents
+        ? { ...closeEvents }
+        : {
+            mouseleave: true,
+            blur: true,
+            click: false,
+        };
+    if (!closeEvents && shouldOpenOnClick) {
+        Object.assign(actualCloseEvents, {
+            mouseleave: false,
+            blur: false,
+        });
+    }
+    const actualGlobalCloseEvents = globalCloseEvents
+        ? { ...globalCloseEvents }
+        : {
+            escape: closeOnEsc || false,
+            scroll: closeOnScroll || false,
+            resize: closeOnResize || false,
+            clickOutsideAnchor: hasClickEvent || false,
+        };
     /**
      * useLayoutEffect runs before useEffect,
      * but should be used carefully because of caveats
@@ -359,23 +398,6 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             mounted.current = false;
         };
     }, []);
-    useEffect(() => {
-        if (!show) {
-            /**
-             * this fixes weird behavior when switching between two anchor elements very quickly
-             * remove the timeout and switch quickly between two adjancent anchor elements to see it
-             *
-             * in practice, this means the tooltip is not immediately removed from the DOM on hide
-             */
-            const timeout = setTimeout(() => {
-                setRendered(false);
-            }, 150);
-            return () => {
-                clearTimeout(timeout);
-            };
-        }
-        return () => null;
-    }, [show]);
     const handleShow = (value) => {
         if (!mounted.current) {
             return;
@@ -424,7 +446,6 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             afterShow === null || afterShow === void 0 ? void 0 : afterShow();
         }
         else {
-            setImperativeOptions(null);
             afterHide === null || afterHide === void 0 ? void 0 : afterHide();
         }
     }, [show]);
@@ -535,17 +556,8 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         handleTooltipPosition(mousePosition);
         lastFloatPosition.current = mousePosition;
     };
-    const handleClickTooltipAnchor = (event) => {
-        handleShowTooltip(event);
-        if (delayHide) {
-            handleHideTooltipDelayed();
-        }
-    };
     const handleClickOutsideAnchors = (event) => {
         var _a;
-        if (!show) {
-            return;
-        }
         const anchorById = document.querySelector(`[id='${anchorId}']`);
         const anchors = [anchorById, ...anchorsBySelect];
         if (anchors.some((anchor) => anchor === null || anchor === void 0 ? void 0 : anchor.contains(event.target))) {
@@ -564,11 +576,9 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
     const debouncedHandleShowTooltip = debounce(handleShowTooltip, 50, true);
     const debouncedHandleHideTooltip = debounce(handleHideTooltip, 50, true);
     const updateTooltipPosition = useCallback(() => {
-        var _a;
-        const actualPosition = (_a = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.position) !== null && _a !== void 0 ? _a : position;
-        if (actualPosition) {
+        if (position) {
             // if `position` is set, override regular and `float` positioning
-            handleTooltipPosition(actualPosition);
+            handleTooltipPosition(position);
             return;
         }
         if (float) {
@@ -619,7 +629,6 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         offset,
         positionStrategy,
         position,
-        imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.position,
         float,
     ]);
     useEffect(() => {
@@ -637,13 +646,13 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         };
         const anchorScrollParent = getScrollParent(activeAnchor);
         const tooltipScrollParent = getScrollParent(tooltipRef.current);
-        if (closeOnScroll) {
+        if (actualGlobalCloseEvents.scroll) {
             window.addEventListener('scroll', handleScrollResize);
             anchorScrollParent === null || anchorScrollParent === void 0 ? void 0 : anchorScrollParent.addEventListener('scroll', handleScrollResize);
             tooltipScrollParent === null || tooltipScrollParent === void 0 ? void 0 : tooltipScrollParent.addEventListener('scroll', handleScrollResize);
         }
         let updateTooltipCleanup = null;
-        if (closeOnResize) {
+        if (actualGlobalCloseEvents.resize) {
             window.addEventListener('resize', handleScrollResize);
         }
         else if (activeAnchor && tooltipRef.current) {
@@ -659,22 +668,56 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             }
             handleShow(false);
         };
-        if (closeOnEsc) {
+        if (actualGlobalCloseEvents.escape) {
             window.addEventListener('keydown', handleEsc);
         }
-        const enabledEvents = [];
-        if (shouldOpenOnClick) {
+        if (actualGlobalCloseEvents.clickOutsideAnchor) {
             window.addEventListener('click', handleClickOutsideAnchors);
-            enabledEvents.push({ event: 'click', listener: handleClickTooltipAnchor });
         }
-        else {
-            enabledEvents.push({ event: 'mouseenter', listener: debouncedHandleShowTooltip }, { event: 'mouseleave', listener: debouncedHandleHideTooltip }, { event: 'focus', listener: debouncedHandleShowTooltip }, { event: 'blur', listener: debouncedHandleHideTooltip });
-            if (float) {
-                enabledEvents.push({
-                    event: 'mousemove',
-                    listener: handleMouseMove,
-                });
+        const enabledEvents = [];
+        const handleClickOpenTooltipAnchor = (event) => {
+            if (show) {
+                return;
+            }
+            handleShowTooltip(event);
+        };
+        const handleClickCloseTooltipAnchor = () => {
+            if (!show) {
+                return;
             }
+            handleHideTooltip();
+        };
+        const regularEvents = ['mouseenter', 'mouseleave', 'focus', 'blur'];
+        const clickEvents = ['click', 'dblclick', 'mousedown', 'mouseup'];
+        Object.entries(actualOpenEvents).forEach(([event, enabled]) => {
+            if (!enabled) {
+                return;
+            }
+            if (regularEvents.includes(event)) {
+                enabledEvents.push({ event, listener: debouncedHandleShowTooltip });
+            }
+            else if (clickEvents.includes(event)) {
+                enabledEvents.push({ event, listener: handleClickOpenTooltipAnchor });
+            }
+            else ;
+        });
+        Object.entries(actualCloseEvents).forEach(([event, enabled]) => {
+            if (!enabled) {
+                return;
+            }
+            if (regularEvents.includes(event)) {
+                enabledEvents.push({ event, listener: debouncedHandleHideTooltip });
+            }
+            else if (clickEvents.includes(event)) {
+                enabledEvents.push({ event, listener: handleClickCloseTooltipAnchor });
+            }
+            else ;
+        });
+        if (float) {
+            enabledEvents.push({
+                event: 'mousemove',
+                listener: handleMouseMove,
+            });
         }
         const handleMouseEnterTooltip = () => {
             hoveringTooltip.current = true;
@@ -683,7 +726,9 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             hoveringTooltip.current = false;
             handleHideTooltip();
         };
-        if (clickable && !shouldOpenOnClick) {
+        if (clickable && !hasClickEvent) {
+            // used to keep the tooltip open when hovering content.
+            // not needed if using click events.
             (_a = tooltipRef.current) === null || _a === void 0 ? void 0 : _a.addEventListener('mouseenter', handleMouseEnterTooltip);
             (_b = tooltipRef.current) === null || _b === void 0 ? void 0 : _b.addEventListener('mouseleave', handleMouseLeaveTooltip);
         }
@@ -695,24 +740,24 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         });
         return () => {
             var _a, _b;
-            if (closeOnScroll) {
+            if (actualGlobalCloseEvents.scroll) {
                 window.removeEventListener('scroll', handleScrollResize);
                 anchorScrollParent === null || anchorScrollParent === void 0 ? void 0 : anchorScrollParent.removeEventListener('scroll', handleScrollResize);
                 tooltipScrollParent === null || tooltipScrollParent === void 0 ? void 0 : tooltipScrollParent.removeEventListener('scroll', handleScrollResize);
             }
-            if (closeOnResize) {
+            if (actualGlobalCloseEvents.resize) {
                 window.removeEventListener('resize', handleScrollResize);
             }
             else {
                 updateTooltipCleanup === null || updateTooltipCleanup === void 0 ? void 0 : updateTooltipCleanup();
             }
-            if (shouldOpenOnClick) {
+            if (actualGlobalCloseEvents.clickOutsideAnchor) {
                 window.removeEventListener('click', handleClickOutsideAnchors);
             }
-            if (closeOnEsc) {
+            if (actualGlobalCloseEvents.escape) {
                 window.removeEventListener('keydown', handleEsc);
             }
-            if (clickable && !shouldOpenOnClick) {
+            if (clickable && !hasClickEvent) {
                 (_a = tooltipRef.current) === null || _a === void 0 ? void 0 : _a.removeEventListener('mouseenter', handleMouseEnterTooltip);
                 (_b = tooltipRef.current) === null || _b === void 0 ? void 0 : _b.removeEventListener('mouseleave', handleMouseLeaveTooltip);
             }
@@ -733,12 +778,14 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         rendered,
         anchorRefs,
         anchorsBySelect,
-        closeOnEsc,
-        events,
+        // the effect uses the `actual*Events` objects, but this should work
+        openEvents,
+        closeEvents,
+        globalCloseEvents,
+        shouldOpenOnClick,
     ]);
     useEffect(() => {
-        var _a, _b;
-        let selector = (_b = (_a = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.anchorSelect) !== null && _a !== void 0 ? _a : anchorSelect) !== null && _b !== void 0 ? _b : '';
+        let selector = anchorSelect !== null && anchorSelect !== void 0 ? anchorSelect : '';
         if (!selector && id) {
             selector = `[data-tooltip-id='${id}']`;
         }
@@ -811,7 +858,7 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             });
             if (newAnchors.length || removedAnchors.length) {
                 setAnchorsBySelect((anchors) => [
-                    ...anchors.filter((anchor) => removedAnchors.includes(anchor)),
+                    ...anchors.filter((anchor) => !removedAnchors.includes(anchor)),
                     ...newAnchors,
                 ]);
             }
@@ -827,7 +874,7 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         return () => {
             documentObserver.disconnect();
         };
-    }, [id, anchorSelect, imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.anchorSelect, activeAnchor]);
+    }, [id, anchorSelect, activeAnchor]);
     useEffect(() => {
         updateTooltipPosition();
     }, [updateTooltipPosition]);
@@ -867,8 +914,7 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
         };
     }, []);
     useEffect(() => {
-        var _a;
-        let selector = (_a = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.anchorSelect) !== null && _a !== void 0 ? _a : anchorSelect;
+        let selector = anchorSelect;
         if (!selector && id) {
             selector = `[data-tooltip-id='${id}']`;
         }
@@ -879,55 +925,28 @@ content, contentWrapperRef, isOpen, setIsOpen, activeAnchor, setActiveAnchor, bo
             const anchors = Array.from(document.querySelectorAll(selector));
             setAnchorsBySelect(anchors);
         }
-        catch (_b) {
+        catch (_a) {
             // warning was already issued in the controller
             setAnchorsBySelect([]);
         }
-    }, [id, anchorSelect, imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.anchorSelect]);
-    const actualContent = (_a = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.content) !== null && _a !== void 0 ? _a : content;
-    const canShow = Boolean(!hidden && actualContent && show && Object.keys(inlineStyles).length > 0);
-    useImperativeHandle(forwardRef, () => ({
-        open: (options) => {
-            if (options === null || options === void 0 ? void 0 : options.anchorSelect) {
-                try {
-                    document.querySelector(options.anchorSelect);
-                }
-                catch (_a) {
-                    {
-                        // eslint-disable-next-line no-console
-                        console.warn(`[react-tooltip] "${options.anchorSelect}" is not a valid CSS selector`);
-                    }
-                    return;
-                }
+    }, [id, anchorSelect]);
+    const canShow = !hidden && content && show && Object.keys(inlineStyles).length > 0;
+    return rendered ? (React.createElement(WrapperElement, { id: id, role: "tooltip", className: classNames('react-tooltip', coreStyles['tooltip'], styles['tooltip'], styles[variant], className, `react-tooltip__place-${actualPlacement}`, coreStyles[canShow ? 'show' : 'closing'], canShow ? 'react-tooltip__show' : 'react-tooltip__closing', positionStrategy === 'fixed' && coreStyles['fixed'], clickable && coreStyles['clickable']), onTransitionEnd: (event) => {
+            /**
+             * @warning if `--rt-transition-closing-delay` is set to 0,
+             * the tooltip will be stuck (but not visible) on the DOM
+             */
+            if (show || event.propertyName !== 'opacity') {
+                return;
             }
-            setImperativeOptions(options !== null && options !== void 0 ? options : null);
-            handleShow(true);
-        },
-        close: () => {
-            handleShow(false);
-        },
-        activeAnchor,
-        place: actualPlacement,
-        isOpen: rendered && canShow,
-    }));
-    return rendered ? (React.createElement(WrapperElement, { id: id, role: "tooltip", className: classNames('react-tooltip', coreStyles['tooltip'], styles['tooltip'], styles[variant], className, `react-tooltip__place-${actualPlacement}`, {
-            'react-tooltip__show': canShow,
-            [coreStyles['show']]: canShow,
-            [coreStyles['fixed']]: positionStrategy === 'fixed',
-            [coreStyles['clickable']]: clickable,
-        }), style: {
+            setRendered(false);
+        }, style: {
             ...externalStyles,
             ...inlineStyles,
             opacity: opacity !== undefined && canShow ? opacity : undefined,
         }, ref: tooltipRef },
-        actualContent,
-        React.createElement(WrapperElement, { className: classNames('react-tooltip-arrow', coreStyles['arrow'], styles['arrow'], classNameArrow, {
-                /**
-                 * changed from dash `no-arrow` to camelcase because of:
-                 * https://github.com/indooorsman/esbuild-css-modules-plugin/issues/42
-                 */
-                [coreStyles['noArrow']]: noArrow,
-            }), style: {
+        content,
+        React.createElement(WrapperElement, { className: classNames('react-tooltip-arrow', coreStyles['arrow'], styles['arrow'], classNameArrow, noArrow && coreStyles['noArrow']), style: {
                 ...inlineArrowStyles,
                 background: arrowColor
                     ? `linear-gradient(to right bottom, transparent 50%, ${arrowColor} 50%)`
@@ -940,7 +959,7 @@ const TooltipContent = ({ content }) => {
     return React.createElement("span", { dangerouslySetInnerHTML: { __html: content } });
 };
 
-const TooltipController = React.forwardRef(({ id, anchorId, anchorSelect, content, html, render, className, classNameArrow, variant = 'dark', place = 'top', offset = 10, wrapper = 'div', children = null, events = ['hover'], openOnClick = false, positionStrategy = 'absolute', middlewares, delayShow = 0, delayHide = 0, float = false, hidden = false, noArrow = false, clickable = false, closeOnEsc = false, closeOnScroll = false, closeOnResize = false, style, position, isOpen, disableStyleInjection = false, border, opacity, arrowColor, setIsOpen, afterShow, afterHide, }, ref) => {
+const TooltipController = ({ id, anchorId, anchorSelect, content, html, render, className, classNameArrow, variant = 'dark', place = 'top', offset = 10, wrapper = 'div', children = null, events = ['hover'], openOnClick = false, positionStrategy = 'absolute', middlewares, delayShow = 0, delayHide = 0, float = false, hidden = false, noArrow = false, clickable = false, closeOnEsc = false, closeOnScroll = false, closeOnResize = false, openEvents, closeEvents, globalCloseEvents, style, position, isOpen, disableStyleInjection = false, border, opacity, arrowColor, setIsOpen, afterShow, afterHide, }) => {
     const [tooltipContent, setTooltipContent] = useState(content);
     const [tooltipHtml, setTooltipHtml] = useState(html);
     const [tooltipPlace, setTooltipPlace] = useState(place);
@@ -1164,7 +1183,6 @@ const TooltipController = React.forwardRef(({ id, anchorId, anchorSelect, conten
         renderedContent = React.createElement(TooltipContent, { content: tooltipHtml });
     }
     const props = {
-        forwardRef: ref,
         id,
         anchorId,
         anchorSelect,
@@ -1189,6 +1207,9 @@ const TooltipController = React.forwardRef(({ id, anchorId, anchorSelect, conten
         closeOnEsc,
         closeOnScroll,
         closeOnResize,
+        openEvents,
+        closeEvents,
+        globalCloseEvents,
         style,
         position,
         isOpen,
@@ -1202,7 +1223,7 @@ const TooltipController = React.forwardRef(({ id, anchorId, anchorSelect, conten
         setActiveAnchor: (anchor) => setActiveAnchor(anchor),
     };
     return React.createElement(Tooltip, { ...props });
-});
+};
 
 // those content will be replaced in build time with the `react-tooltip.css` builded content
 const TooltipCoreStyles = `:root {
@@ -1213,17 +1234,17 @@ const TooltipCoreStyles = `:root {
   --rt-color-warning: #f0ad4e;
   --rt-color-info: #337ab7;
   --rt-opacity: 0.9;
+  --rt-transition-show-delay: 0.15s;
+  --rt-transition-closing-delay: 0.15s;
 }
 
 .core-styles-module_tooltip__3vRRp {
-  visibility: hidden;
   position: absolute;
   top: 0;
   left: 0;
   pointer-events: none;
   opacity: 0;
-  transition: opacity 0.3s ease-out;
-  will-change: opacity, visibility;
+  will-change: opacity;
 }
 
 .core-styles-module_fixed__pcSol {
@@ -1244,8 +1265,13 @@ const TooltipCoreStyles = `:root {
 }
 
 .core-styles-module_show__Nt9eE {
-  visibility: visible;
   opacity: var(--rt-opacity);
+  transition: opacity var(--rt-transition-show-delay) ease-out;
+}
+
+.core-styles-module_closing__sGnxF {
+  opacity: 0;
+  transition: opacity var(--rt-transition-closing-delay) ease-in;
 }
 
 `;