v7.0.0

CHANGELOG.md

@@ -1,3 +1,13 @@
+## v7.0.0
+
+-   Изменено значение по умолчанию для параметра `trigger`
+-   Рефакторинг кода и устранение ошибок
+
+## v6.0.0
+
+-   Корректная работа сообытий mouseenter/mouseleave на тач-устройствах
+-   Предовтращаем лишние показы всплывающей подсказки
+
 ## v5.0.0
 
 -   Регистрируем сообытия mouseenter/mouseleave на тач-устройствах

README.md

@@ -43,7 +43,7 @@ createTooltip(document.querySelector('button'), 'Подсказка', {
     placement: 'top',
     shiftPadding: [8, 0],
     theme: 'light',
-    trigger: 'mouseenter',
+    trigger: 'mouseenter click',
     virtualReference: undefined,
     zIndex: '',
     // Callback-функции, по умолчанию не заданы

index.js

@@ -13,13 +13,27 @@ const handleVisibilityChange = () => {
     if (document.hidden) {
         // Скрываем все активные всплывающие подсказки
         for (const $tooltip of document.querySelectorAll('.tooltip')) {
-            if ($tooltip._reference?._tooltip?.isVisible) {
-                $tooltip._reference._tooltip.hide({ immediately: true });
+            const ref = $tooltip._reference;
+            if (ref?._tooltip) {
+                // Очищаем таймеры появления при скрытии страницы
+                clearTimeout(ref._tooltip._showTimeout);
+                if (ref._tooltip.isVisible) {
+                    ref._tooltip.hide({ immediately: true });
+                }
             }
         }
     }
 };
 
+const templates = {
+    arrow: () => `
+        <div class="tooltip__arrow" style="pointer-events: none; position: absolute; transform: rotate(45deg);"></div>
+    `,
+    interactiveHelper: () => `
+        <div class="tooltip__interactive-helper" style="position: absolute; z-index: -1;"></div>
+    `,
+};
+
 export const createTooltip = ($el, content, options) => {
     options = {
         animation: [
@@ -37,7 +51,7 @@ export const createTooltip = ($el, content, options) => {
         placement: 'top',
         shiftPadding: [8, 0],
         theme: 'light',
-        trigger: 'mouseenter',
+        trigger: 'mouseenter click',
         virtualReference: undefined,
         zIndex: '',
         ...options,
@@ -53,8 +67,6 @@ export const createTooltip = ($el, content, options) => {
         }
     }
 
-    let showTimeout;
-    let hideTimeout;
     let rafId;
     const listeners = [];
 
@@ -65,7 +77,11 @@ export const createTooltip = ($el, content, options) => {
         $container: undefined,
         $arrow: undefined,
         $interactive: undefined,
+        _showTimeout: undefined,
+        _hideTimeout: undefined,
+        _currentAnimation: undefined,
         autoUpdateCleanup: () => {},
+        updatePosition: async () => {},
 
         setContent(updatedContent) {
             if (updatedContent !== undefined) {
@@ -89,15 +105,7 @@ export const createTooltip = ($el, content, options) => {
             if (updatedOptions.arrow !== undefined && $el._tooltip.$tooltip) {
                 if (options.arrow) {
                     if (!$el._tooltip.$arrow) {
-                        $el._tooltip.$tooltip.insertAdjacentHTML(
-                            'afterbegin',
-                            `
-                                <div
-                                    class="tooltip__arrow"
-                                    style="pointer-events: none; position: absolute; transform: rotate(45deg);">
-                                </div>
-                            `,
-                        );
+                        $el._tooltip.$tooltip.querySelector('.tooltip__root').insertAdjacentHTML('afterbegin', templates.arrow());
                         $el._tooltip.$arrow = $el._tooltip.$tooltip.querySelector('.tooltip__arrow');
                     }
                 } else {
@@ -115,15 +123,7 @@ export const createTooltip = ($el, content, options) => {
                 if ($el._tooltip.$tooltip) {
                     if (options.interactive) {
                         if (!$el._tooltip.$interactive) {
-                            $el._tooltip.$tooltip.insertAdjacentHTML(
-                                'afterbegin',
-                                `
-                                    <div
-                                        class="tooltip__interactive-helper"
-                                        style="position: absolute; z-index: -1;">
-                                    </div>
-                                `,
-                            );
+                            $el._tooltip.$tooltip.querySelector('.tooltip__root').insertAdjacentHTML('afterbegin', templates.interactiveHelper());
                             $el._tooltip.$interactive =
                                 $el._tooltip.$tooltip.querySelector('.tooltip__interactive-helper');
                         }
@@ -162,8 +162,9 @@ export const createTooltip = ($el, content, options) => {
                 return;
             }
 
-            clearTimeout(showTimeout);
-            clearTimeout(hideTimeout);
+            clearTimeout($el._tooltip._showTimeout);
+            clearTimeout($el._tooltip._hideTimeout);
+            $el._tooltip._currentAnimation?.cancel();
             cancelAnimationFrame(rafId);
 
             $el._tooltip.$tooltip?.remove();
@@ -178,6 +179,8 @@ export const createTooltip = ($el, content, options) => {
             }
             listeners.length = 0;
 
+            document.body.removeEventListener('click', $el._tooltip.hideOnClickListener);
+
             delete $el._tooltip;
         },
     };
@@ -187,7 +190,7 @@ export const createTooltip = ($el, content, options) => {
     }
 
     $el._tooltip.show = async ({ immediately } = {}) => {
-        clearTimeout(hideTimeout);
+        clearTimeout($el._tooltip._hideTimeout);
 
         if (!$el._tooltip.$tooltip) {
             const { computePosition, offset, flip, shift, arrow } = await import('@floating-ui/dom');
@@ -199,26 +202,8 @@ export const createTooltip = ($el, content, options) => {
 
             $el._tooltip.$tooltip.innerHTML = `
                 <div class="tooltip__root">
-                    ${
-                        options.interactive
-                            ? `
-                                <div
-                                    class="tooltip__interactive-helper"
-                                    style="position: absolute; z-index: -1;">
-                                </div>
-                            `
-                            : ''
-                    }
-                    ${
-                        options.arrow
-                            ? `
-                                <div
-                                    class="tooltip__arrow"
-                                    style="pointer-events: none; position: absolute; transform: rotate(45deg);">
-                                </div>
-                            `
-                            : ''
-                    }
+                    ${options.interactive ? templates.interactiveHelper() : ''}
+                    ${options.arrow ? templates.arrow() : ''}
                     <div class="tooltip__container"></div>
                 </div>
             `;
@@ -294,10 +279,18 @@ export const createTooltip = ($el, content, options) => {
 
         const { autoUpdate } = await import('@floating-ui/dom');
 
-        showTimeout = setTimeout(
+        $el._tooltip._showTimeout = setTimeout(
             async () => {
-                // Проверяем $el._tooltip на сущестование
-                if (!$el._tooltip || $el._tooltip.isVisible) {
+                const isMouseEnterTrigger = options.trigger.includes('mouseenter');
+                const isHovering = $el.matches(':hover');
+
+                // Проверяем $el._tooltip на сущестование и актуальность показа всплывающей подсказки
+                if (
+                    !$el._tooltip ||
+                    $el._tooltip.isVisible ||
+                    (isMouseEnterTrigger && !isHovering) ||
+                    document.hidden
+                ) {
                     return;
                 }
 
@@ -319,10 +312,13 @@ export const createTooltip = ($el, content, options) => {
                 }
 
                 try {
-                    await $el._tooltip.$tooltip.querySelector('.tooltip__root').animate(options.animation[0], {
+                    $el._tooltip._currentAnimation?.cancel();
+                    const animation = $el._tooltip.$tooltip.querySelector('.tooltip__root').animate(options.animation[0], {
                         duration: immediately ? 0 : options.duration[0],
                         easing: options.easing[0],
-                    }).finished;
+                    });
+                    $el._tooltip._currentAnimation = animation;
+                    await animation.finished;
                 } catch {} // eslint-disable-line no-empty
 
                 if (options.onShown) {
@@ -334,8 +330,8 @@ export const createTooltip = ($el, content, options) => {
     };
 
     $el._tooltip.hide = ({ immediately } = {}) => {
-        clearTimeout(showTimeout);
-        hideTimeout = setTimeout(
+        clearTimeout($el._tooltip._showTimeout);
+        $el._tooltip._hideTimeout = setTimeout(
             async () => {
                 // Проверяем $el._tooltip на сущестование
                 if (!$el._tooltip || !$el._tooltip.isVisible) {
@@ -346,11 +342,16 @@ export const createTooltip = ($el, content, options) => {
                     options.onHide($el._tooltip);
                 }
 
+                document.body.removeEventListener('click', $el._tooltip.hideOnClickListener);
+
                 try {
-                    await $el._tooltip.$tooltip.querySelector('.tooltip__root').animate(options.animation[1], {
+                    $el._tooltip._currentAnimation?.cancel();
+                    const animation = $el._tooltip.$tooltip.querySelector('.tooltip__root').animate(options.animation[1], {
                         duration: immediately ? 0 : options.duration[1],
                         easing: options.easing[1],
-                    }).finished;
+                    });
+                    $el._tooltip._currentAnimation = animation;
+                    await animation.finished;
                 } catch {} // eslint-disable-line no-empty
 
                 // Ещё одна проверка на сущестование $el._tooltip после await
@@ -379,37 +380,47 @@ export const createTooltip = ($el, content, options) => {
 
         if (options.hideOnClick === 'all') {
             $el._tooltip.hide();
-            document.body.removeEventListener('click', $el._tooltip.hideOnClickListener);
         } else if (options.hideOnClick === 'toggle') {
             if ($el.contains(target)) {
                 $el._tooltip.hide();
-                document.body.removeEventListener('click', $el._tooltip.hideOnClickListener);
             }
         } else {
             // options.hideOnClick === true
             if ($el.contains(target) || !$el._tooltip.$tooltip.contains(target)) {
                 $el._tooltip.hide();
-                document.body.removeEventListener('click', $el._tooltip.hideOnClickListener);
             }
         }
     };
 
     $el._tooltip.clickListener = () => {
+        if (document.hidden) {
+            return;
+        }
         if (!$el._tooltip.isVisible) {
             $el._tooltip.show();
         }
     };
 
-    $el._tooltip.mouseEnterListener = () => {
+    $el._tooltip.mouseEnterListener = (event) => {
+        if (event.pointerType !== 'mouse' || document.hidden) {
+            return;
+        }
         $el._tooltip.show();
     };
 
-    $el._tooltip.mouseLeaveListener = ({ relatedTarget }) => {
-        if (options.interactive && relatedTarget && $el._tooltip.$tooltip?.contains(relatedTarget)) {
+    $el._tooltip.mouseLeaveListener = (event) => {
+        if (event.pointerType !== 'mouse') {
+            return;
+        }
+
+        if (options.interactive && event.relatedTarget && $el._tooltip.$tooltip?.contains(event.relatedTarget)) {
             $el._tooltip.$tooltip.addEventListener(
-                'mouseleave',
-                ({ relatedTarget }) => {
-                    if (!relatedTarget || !$el.contains(relatedTarget)) {
+                'pointerleave',
+                (event) => {
+                    if (event.pointerType !== 'mouse') {
+                        return;
+                    }
+                    if (!event.relatedTarget || !$el.contains(event.relatedTarget)) {
                         $el._tooltip.hide();
                     }
                 },
@@ -421,6 +432,9 @@ export const createTooltip = ($el, content, options) => {
     };
 
     $el._tooltip.focusListener = () => {
+        if (document.hidden) {
+            return;
+        }
         $el._tooltip.show();
     };
 
@@ -432,11 +446,11 @@ export const createTooltip = ($el, content, options) => {
         for (const trigger of options.trigger.split(' ')) {
             switch (trigger) {
                 case 'mouseenter': {
-                    $el.addEventListener('mouseenter', $el._tooltip.mouseEnterListener);
-                    listeners.push({ el: $el, event: 'mouseenter', listener: $el._tooltip.mouseEnterListener });
+                    $el.addEventListener('pointerenter', $el._tooltip.mouseEnterListener);
+                    listeners.push({ el: $el, event: 'pointerenter', listener: $el._tooltip.mouseEnterListener });
 
-                    $el.addEventListener('mouseleave', $el._tooltip.mouseLeaveListener);
-                    listeners.push({ el: $el, event: 'mouseleave', listener: $el._tooltip.mouseLeaveListener });
+                    $el.addEventListener('pointerleave', $el._tooltip.mouseLeaveListener);
+                    listeners.push({ el: $el, event: 'pointerleave', listener: $el._tooltip.mouseLeaveListener });
                     break;
                 }
                 case 'click': {
@@ -444,8 +458,8 @@ export const createTooltip = ($el, content, options) => {
                     listeners.push({ el: $el, event: 'click', listener: $el._tooltip.clickListener });
 
                     if (!options.interactive) {
-                        $el.addEventListener('mouseleave', $el._tooltip.mouseLeaveListener);
-                        listeners.push({ el: $el, event: 'mouseleave', listener: $el._tooltip.mouseLeaveListener });
+                        $el.addEventListener('pointerleave', $el._tooltip.mouseLeaveListener);
+                        listeners.push({ el: $el, event: 'pointerleave', listener: $el._tooltip.mouseLeaveListener });
                     }
                     break;
                 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@advdominion/tooltip",
-    "version": "5.0.0",
+    "version": "7.0.0",
     "type": "module",
     "packageManager": "yarn@4.9.4",
     "main": "index.js",