import tippy from 'tippy.js'; const visibleInstances = new Set(); export function createTippy(target, opts = {}) { const instance = tippy(target, { appendTo: document.body, animation: false, allowHTML: false, hideOnClick: false, interactiveBorder: 20, ignoreAttributes: true, maxWidth: 500, // increase over default 350px onHide: (instance) => { visibleInstances.delete(instance); }, onDestroy: (instance) => { visibleInstances.delete(instance); }, onShow: (instance) => { // hide other tooltip instances so only one tooltip shows at a time for (const visibleInstance of visibleInstances) { if (visibleInstance.props.role === 'tooltip') { visibleInstance.hide(); } } visibleInstances.add(instance); }, arrow: ``, ...(opts?.role && {theme: opts.role}), ...opts, }); // for popups where content refers to a DOM element, we use the 'tippy-target' class // to initially hide the content, now we can remove it as the content has been removed // from the DOM by tippy if (opts.content instanceof Element) { opts.content.classList.remove('tippy-target'); } return instance; } /** * Attach a tooltip tippy to the given target element. * If the target element already has a tooltip tippy attached, the tooltip will be updated with the new content. * If the target element has no content, then no tooltip will be attached, and it returns null. * * Note: "tooltip" doesn't equal to "tippy". "tooltip" means a auto-popup content, it just uses tippy as the implementation. * * @param target {HTMLElement} * @param content {null|string} * @returns {null|tippy} */ function attachTooltip(target, content = null) { switchTitleToTooltip(target); content = content ?? target.getAttribute('data-tooltip-content'); if (!content) return null; const props = { content, delay: 100, role: 'tooltip', placement: target.getAttribute('data-tooltip-placement') || 'top-start', ...(target.getAttribute('data-tooltip-interactive') === 'true' ? {interactive: true, aria: {content: 'describedby', expanded: false}} : {}), }; if (!target._tippy) { createTippy(target, props); } else { target._tippy.setProps(props); } return target._tippy; } function switchTitleToTooltip(target) { const title = target.getAttribute('title'); if (title) { target.setAttribute('data-tooltip-content', title); target.setAttribute('aria-label', title); // keep the attribute, in case there are some other "[title]" selectors // and to prevent infinite loop with which will re-add // title if it is absent target.setAttribute('title', ''); } } /** * Creating tooltip tippy instance is expensive, so we only create it when the user hovers over the element * According to https://www.w3.org/TR/DOM-Level-3-Events/#events-mouseevent-event-order , mouseover event is fired before mouseenter event * Some old browsers like Pale Moon doesn't support "mouseenter(capture)" * The tippy by default uses "mouseenter" event to show, so we use "mouseover" event to switch to tippy * @param e {Event} */ function lazyTooltipOnMouseHover(e) { e.target.removeEventListener('mouseover', lazyTooltipOnMouseHover, true); attachTooltip(this); } // Activate the tooltip for current element. // If the element has no aria-label, use the tooltip content as aria-label. function attachLazyTooltip(el) { el.addEventListener('mouseover', lazyTooltipOnMouseHover, {capture: true}); // meanwhile, if the element has no aria-label, use the tooltip content as aria-label if (!el.hasAttribute('aria-label')) { const content = el.getAttribute('data-tooltip-content'); if (content) { el.setAttribute('aria-label', content); } } } // Activate the tooltip for all children elements. function attachChildrenLazyTooltip(target) { for (const el of target.querySelectorAll('[data-tooltip-content]')) { attachLazyTooltip(el); } } const elementNodeTypes = new Set([Node.ELEMENT_NODE, Node.DOCUMENT_FRAGMENT_NODE]); export function initGlobalTooltips() { // use MutationObserver to detect new "data-tooltip-content" elements added to the DOM, or attributes changed const observerConnect = (observer) => observer.observe(document, { subtree: true, childList: true, attributeFilter: ['data-tooltip-content', 'title'] }); const observer = new MutationObserver((mutationList, observer) => { const pending = observer.takeRecords(); observer.disconnect(); for (const mutation of [...mutationList, ...pending]) { if (mutation.type === 'childList') { // mainly for Vue components and AJAX rendered elements for (const el of mutation.addedNodes) { if (elementNodeTypes.has(el.nodeType)) { attachChildrenLazyTooltip(el); if (el.hasAttribute('data-tooltip-content')) { attachLazyTooltip(el); } } } } else if (mutation.type === 'attributes') { attachTooltip(mutation.target); } } observerConnect(observer); }); observerConnect(observer); attachChildrenLazyTooltip(document.documentElement); } export function showTemporaryTooltip(target, content) { const tippy = target._tippy ?? attachTooltip(target, content); tippy.setContent(content); if (!tippy.state.isShown) tippy.show(); tippy.setProps({ onHidden: (tippy) => { // reset the default tooltip content, if no default, then this temporary tooltip could be destroyed if (!attachTooltip(target)) { tippy.destroy(); } }, }); }