import { getContext, setContext } from 'svelte'; import { derived, type Readable, writable } from 'svelte/store'; import { noop } from 'lodash-es'; import { floatingStyle, type FloatingStyleStore } from '../floating'; import { uniqueId } from '../unique-id'; export type TooltipVisibility = 'invisible' | 'visible'; export interface TooltipContext { id: string; style: FloatingStyleStore; isVisible: Readable; setHovered: (isHovered: boolean) => void; setVisibility: (visibility: TooltipVisibility | undefined) => void; setHoverDelayMS: (hoverDelayMS: number) => void; } export interface TooltipElements { target?: HTMLElement; tooltip?: HTMLElement; arrow?: HTMLElement; } const CONTEXT_KEY = Symbol('tooltip'); /** * Create and provide a context for the components of a tooltip. * * @returns tooltip ID, styles, and reactive actions */ export const provideTooltipContext = (): TooltipContext => { const context = createContext(); setContext(CONTEXT_KEY, context); return context; }; /** * Use a provided tooltip context inside a tooltip component. * * @returns tooltip ID, styles, and reactive actions */ export const useTooltip = (): TooltipContext => { const context = getContext(CONTEXT_KEY); if (!context) { throw new Error('Usage: tooltip context required'); } return context; }; /** Create a context for a single tooltip */ const createContext = (): TooltipContext => { const id = uniqueId('tooltip'); const isHovered = writable(false); const visibility = writable(); const hoverDelayMS = writable(); const isVisible = derived( [isHovered, visibility, hoverDelayMS], ([$isHovered, $visibility, $hoverDelayMS], set) => { let cleanup = noop; if ($visibility === 'visible') { set(true); } else if ($visibility === 'invisible' || !$isHovered) { set(false); } else { const timeoutID = setTimeout(() => set(true), $hoverDelayMS); cleanup = () => clearTimeout(timeoutID); } return cleanup; }, false ); const style = floatingStyle({ offset: 7, shift: { padding: 5 }, flip: { fallbackAxisSideDirection: 'start', crossAxis: false }, auto: false, }); return { id, isVisible, style, setHovered: isHovered.set, setVisibility: visibility.set, setHoverDelayMS: hoverDelayMS.set, }; };