egirlskey/packages/frontend/src/scripts/use-tooltip.ts

106 lines
2.9 KiB
TypeScript
Raw Normal View History

/*
* SPDX-FileCopyrightText: syuilo and other misskey contributors
* SPDX-License-Identifier: AGPL-3.0-only
*/
2021-12-24 03:34:24 +00:00
import { Ref, ref, watch, onUnmounted } from 'vue';
2021-12-05 11:01:52 +00:00
export function useTooltip(
elRef: Ref<HTMLElement | { $el: HTMLElement } | null | undefined>,
onShow: (showing: Ref<boolean>) => void,
2022-06-30 14:51:18 +00:00
delay = 300,
2021-12-05 11:01:52 +00:00
): void {
let isHovering = false;
2021-12-05 11:01:52 +00:00
// iOS(Androidも)では、要素をタップした直後に(おせっかいで)mouseoverイベントを発火させたりするため、それを無視するためのフラグ
// 無視しないと、画面に触れてないのにツールチップが出たりし、ユーザビリティが損なわれる
// TODO: 一度でもタップすると二度とマウスでツールチップ出せなくなるのをどうにかする 定期的にfalseに戻すとか...
let shouldIgnoreMouseover = false;
let timeoutId: number;
let changeShowingState: (() => void) | null;
let autoHidingTimer;
const open = () => {
close();
if (!isHovering) return;
2021-12-23 08:05:26 +00:00
if (elRef.value == null) return;
const el = elRef.value instanceof Element ? elRef.value : elRef.value.$el;
if (!document.body.contains(el)) return; // openしようとしたときに既に元要素がDOMから消えている場合があるため
const showing = ref(true);
onShow(showing);
changeShowingState = () => {
showing.value = false;
};
autoHidingTimer = window.setInterval(() => {
if (!document.body.contains(elRef.value)) {
if (!isHovering) return;
isHovering = false;
window.clearTimeout(timeoutId);
close();
window.clearInterval(autoHidingTimer);
}
}, 1000);
};
const close = () => {
if (changeShowingState != null) {
changeShowingState();
changeShowingState = null;
}
};
const onMouseover = () => {
if (isHovering) return;
2021-12-05 11:01:52 +00:00
if (shouldIgnoreMouseover) return;
isHovering = true;
2022-06-30 14:51:18 +00:00
timeoutId = window.setTimeout(open, delay);
};
const onMouseleave = () => {
if (!isHovering) return;
isHovering = false;
window.clearTimeout(timeoutId);
window.clearInterval(autoHidingTimer);
close();
};
2021-12-05 11:01:52 +00:00
const onTouchstart = () => {
shouldIgnoreMouseover = true;
if (isHovering) return;
isHovering = true;
2022-06-30 14:51:18 +00:00
timeoutId = window.setTimeout(open, delay);
2021-12-05 11:01:52 +00:00
};
const onTouchend = () => {
if (!isHovering) return;
isHovering = false;
window.clearTimeout(timeoutId);
window.clearInterval(autoHidingTimer);
2021-12-05 11:01:52 +00:00
close();
};
2021-12-05 11:01:52 +00:00
const stop = watch(elRef, () => {
if (elRef.value) {
stop();
const el = elRef.value instanceof Element ? elRef.value : elRef.value.$el;
el.addEventListener('mouseover', onMouseover, { passive: true });
el.addEventListener('mouseleave', onMouseleave, { passive: true });
el.addEventListener('touchstart', onTouchstart, { passive: true });
el.addEventListener('touchend', onTouchend, { passive: true });
2021-12-24 03:34:24 +00:00
el.addEventListener('click', close, { passive: true });
2021-12-05 11:01:52 +00:00
}
}, {
immediate: true,
flush: 'post',
});
2021-12-24 03:34:24 +00:00
onUnmounted(() => {
close();
});
}