web/src/lib/actions/tooltip.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import {
  computePosition,
  offset,
  flip,
  arrow,
  hide,
  type Placement,
  shift,
  autoUpdate
} from '@floating-ui/dom';
import { writable } from 'svelte/store';
import { v4 as uuidv4 } from 'uuid';

const openId = writable<string | null>(null);

type TooltipOptions = {
  placement?: Placement;
  clickable?: boolean;
  isTrigger?: boolean;
};

export function tooltip(
  node: HTMLElement | null,
  { placement = 'right', clickable, isTrigger }: TooltipOptions
) {
  if (!node) return;
  const trigger = isTrigger ? node : (node.querySelector('[data-trigger]') as HTMLElement);
  const tooltip = node.querySelector('.tooltip') as HTMLElement;

  if (!tooltip || !trigger) return;
  const id = uuidv4();

  let cleanup: VoidFunction | undefined;

  const unsub = openId.subscribe((val) => (val === id ? showTooltip() : hideTooltip()));

  const closeTooltip = () => openId.set(null);
  const toggleOpen = () => openId.update((val) => (val === id ? null : id));

  const onOutsideClick = (e: MouseEvent) => {
    if (!tooltip.contains(e.target as HTMLElement)) {
      closeTooltip();
    }
  };

  const onTriggerClick = (e: MouseEvent) => {
    e.preventDefault();
    e.stopPropagation();
    toggleOpen();
  };

  if (clickable) {
    document.addEventListener('click', onOutsideClick);
    trigger.addEventListener('click', onTriggerClick);
  }

  tooltip.addEventListener('closeTooltip', closeTooltip);

  const arrowEl = document.createElement('div');
  arrowEl.className = 'arrow';
  tooltip.appendChild(arrowEl);

  const updatePosition = () => {
    cleanup = autoUpdate(trigger, tooltip, () => {
      computePosition(trigger, tooltip, {
        placement,
        middleware: [
          offset(10),
          flip({ padding: 5 }),
          shift({ padding: 5 }),
          arrow({ element: arrowEl }),
          hide()
        ]
      }).then(({ x, y, placement, middlewareData }) => {
        Object.assign(tooltip.style, {
          left: `${x}px`,
          top: `${y}px`,
          visibility: middlewareData.hide?.referenceHidden ? 'hidden' : 'visible'
        });

        tooltip.dataset.placement = placement;

        const { x: arrowX, y: arrowY } = middlewareData.arrow!;

        const staticSide = {
          top: 'bottom',
          right: 'left',
          bottom: 'top',
          left: 'right'
        }[placement.split('-')[0]]!;

        arrowEl.dataset.placement = placement;

        Object.assign(arrowEl.style, {
          left: arrowX != null ? `${arrowX}px` : '',
          top: arrowY != null ? `${arrowY}px` : '',
          right: '',
          bottom: '',
          [staticSide]: '-5px'
        });
      });
    });
  };

  function showTooltip() {
    tooltip.style.display = 'block';
    tooltip.style.opacity = '0';
    tooltip.style.transform = 'scale(0.93)';

    updatePosition();

    setTimeout(() => {
      tooltip.style.opacity = '1';
      tooltip.style.transform = 'scale(1)';
    }, 0);
  }

  function hideTooltip() {
    tooltip.style.opacity = '0';
    tooltip.style.transform = 'scale(0.93)';

    if (typeof cleanup === 'function') {
      cleanup();
    }

    setTimeout(() => {
      tooltip.style.display = 'none';
    }, 205);
  }

  const actions = [
    ['mouseenter', showTooltip],
    ['mouseleave', hideTooltip],
    ['focus', showTooltip],
    ['blur-sm', hideTooltip]
  ] as const;

  if (!clickable) {
    actions.forEach(([event, listener]) => {
      trigger.addEventListener(event, listener);
    });
  }

  return {
    destroy() {
      if (typeof cleanup === 'function') {
        cleanup();
      }

      trigger.removeEventListener('click', onTriggerClick);
      tooltip.removeEventListener('closeTooltip', closeTooltip);
      document.removeEventListener('click', onOutsideClick);
      actions.forEach(([event, listener]) => {
        trigger.removeEventListener(event, listener);
      });

      unsub();
    }
  };
}