react-tooltip 5.22.0-beta.1109.1 → 5.22.0

package/dist/react-tooltip.umd.js

@@ -325,16 +325,15 @@
         });
     };
 
-    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 = React.useRef(null);
         const tooltipArrowRef = React.useRef(null);
         const tooltipShowDelayTimerRef = React.useRef(null);
@@ -344,7 +343,6 @@
         const [inlineArrowStyles, setInlineArrowStyles] = React.useState({});
         const [show, setShow] = React.useState(false);
         const [rendered, setRendered] = React.useState(false);
-        const [imperativeOptions, setImperativeOptions] = React.useState(null);
         const wasShowing = React.useRef(false);
         const lastFloatPosition = React.useRef(null);
         /**
@@ -354,7 +352,48 @@
         const hoveringTooltip = React.useRef(false);
         const [anchorsBySelect, setAnchorsBySelect] = React.useState([]);
         const mounted = React.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
@@ -366,23 +405,6 @@
                 mounted.current = false;
             };
         }, []);
-        React.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;
@@ -431,17 +453,16 @@
                 afterShow === null || afterShow === void 0 ? void 0 : afterShow();
             }
             else {
-                setImperativeOptions(null);
                 afterHide === null || afterHide === void 0 ? void 0 : afterHide();
             }
         }, [show]);
-        const handleShowTooltipDelayed = (delay = delayShow) => {
+        const handleShowTooltipDelayed = () => {
             if (tooltipShowDelayTimerRef.current) {
                 clearTimeout(tooltipShowDelayTimerRef.current);
             }
             tooltipShowDelayTimerRef.current = setTimeout(() => {
                 handleShow(true);
-            }, delay);
+            }, delayShow);
         };
         const handleHideTooltipDelayed = (delay = delayHide) => {
             if (tooltipHideDelayTimerRef.current) {
@@ -497,7 +518,6 @@
             }
         };
         const handleTooltipPosition = ({ x, y }) => {
-            var _a;
             const virtualElement = {
                 getBoundingClientRect() {
                     return {
@@ -513,7 +533,7 @@
                 },
             };
             computeTooltipPosition({
-                place: (_a = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.place) !== null && _a !== void 0 ? _a : place,
+                place,
                 offset,
                 elementReference: virtualElement,
                 tooltipReference: tooltipRef.current,
@@ -543,17 +563,8 @@
             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))) {
@@ -572,11 +583,9 @@
         const debouncedHandleShowTooltip = debounce(handleShowTooltip, 50, true);
         const debouncedHandleHideTooltip = debounce(handleHideTooltip, 50, true);
         const updateTooltipPosition = React.useCallback(() => {
-            var _a, _b;
-            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) {
@@ -597,7 +606,7 @@
                 return;
             }
             computeTooltipPosition({
-                place: (_b = imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.place) !== null && _b !== void 0 ? _b : place,
+                place,
                 offset,
                 elementReference: activeAnchor,
                 tooltipReference: tooltipRef.current,
@@ -624,11 +633,9 @@
             content,
             externalStyles,
             place,
-            imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.place,
             offset,
             positionStrategy,
             position,
-            imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.position,
             float,
         ]);
         React.useEffect(() => {
@@ -646,13 +653,13 @@
             };
             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) {
@@ -668,22 +675,56 @@
                 }
                 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;
@@ -692,7 +733,9 @@
                 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);
             }
@@ -704,24 +747,24 @@
             });
             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);
                 }
@@ -742,12 +785,14 @@
             rendered,
             anchorRefs,
             anchorsBySelect,
-            closeOnEsc,
-            events,
+            // the effect uses the `actual*Events` objects, but this should work
+            openEvents,
+            closeEvents,
+            globalCloseEvents,
+            shouldOpenOnClick,
         ]);
         React.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}']`;
             }
@@ -820,7 +865,7 @@
                 });
                 if (newAnchors.length || removedAnchors.length) {
                     setAnchorsBySelect((anchors) => [
-                        ...anchors.filter((anchor) => removedAnchors.includes(anchor)),
+                        ...anchors.filter((anchor) => !removedAnchors.includes(anchor)),
                         ...newAnchors,
                     ]);
                 }
@@ -836,7 +881,7 @@
             return () => {
                 documentObserver.disconnect();
             };
-        }, [id, anchorSelect, imperativeOptions === null || imperativeOptions === void 0 ? void 0 : imperativeOptions.anchorSelect, activeAnchor]);
+        }, [id, anchorSelect, activeAnchor]);
         React.useEffect(() => {
             updateTooltipPosition();
         }, [updateTooltipPosition]);
@@ -876,8 +921,7 @@
             };
         }, []);
         React.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}']`;
             }
@@ -888,65 +932,28 @@
                 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);
-        React.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;
-                    }
-                }
-                setImperativeOptions(options !== null && options !== void 0 ? options : null);
-                if (options === null || options === void 0 ? void 0 : options.delay) {
-                    handleShowTooltipDelayed(options.delay);
-                }
-                else {
-                    handleShow(true);
-                }
-            },
-            close: (options) => {
-                if (options === null || options === void 0 ? void 0 : options.delay) {
-                    handleHideTooltipDelayed(options.delay);
-                }
-                else {
-                    handleShow(false);
+        }, [id, anchorSelect]);
+        const canShow = !hidden && content && show && Object.keys(inlineStyles).length > 0;
+        return rendered ? (React__default["default"].createElement(WrapperElement, { id: id, role: "tooltip", className: classNames__default["default"]('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;
                 }
-            },
-            activeAnchor,
-            place: actualPlacement,
-            isOpen: rendered && canShow,
-        }));
-        return rendered ? (React__default["default"].createElement(WrapperElement, { id: id, role: "tooltip", className: classNames__default["default"]('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__default["default"].createElement(WrapperElement, { className: classNames__default["default"]('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__default["default"].createElement(WrapperElement, { className: classNames__default["default"]('react-tooltip-arrow', coreStyles['arrow'], styles['arrow'], classNameArrow, noArrow && coreStyles['noArrow']), style: {
                     ...inlineArrowStyles,
                     background: arrowColor
                         ? `linear-gradient(to right bottom, transparent 50%, ${arrowColor} 50%)`
@@ -959,7 +966,7 @@
         return React__default["default"].createElement("span", { dangerouslySetInnerHTML: { __html: content } });
     };
 
-    const TooltipController = React__default["default"].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] = React.useState(content);
         const [tooltipHtml, setTooltipHtml] = React.useState(html);
         const [tooltipPlace, setTooltipPlace] = React.useState(place);
@@ -1183,7 +1190,6 @@
             renderedContent = React__default["default"].createElement(TooltipContent, { content: tooltipHtml });
         }
         const props = {
-            forwardRef: ref,
             id,
             anchorId,
             anchorSelect,
@@ -1208,6 +1214,9 @@
             closeOnEsc,
             closeOnScroll,
             closeOnResize,
+            openEvents,
+            closeEvents,
+            globalCloseEvents,
             style,
             position,
             isOpen,
@@ -1221,7 +1230,7 @@
             setActiveAnchor: (anchor) => setActiveAnchor(anchor),
         };
         return React__default["default"].createElement(Tooltip, { ...props });
-    });
+    };
 
     // those content will be replaced in build time with the `react-tooltip.css` builded content
     const TooltipCoreStyles = `:root {
@@ -1232,17 +1241,17 @@
   --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 {
@@ -1263,8 +1272,13 @@
 }
 
 .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;
 }
 
 `;