Files

110 lines
3.7 KiB
TypeScript
Raw Permalink Normal View History

2025-07-01 21:44:05 +08:00
import {htmlEscape} from '../utils/html.ts';
import {svg} from '../svg.ts';
import {animateOnce, queryElems, showElem} from '../utils/dom.ts';
2023-08-23 15:25:13 +08:00
import Toastify from 'toastify-js'; // don't use "async import", because when network error occurs, the "async import" also fails and nothing is shown
import type {Intent} from '../types.ts';
import type {SvgName} from '../svg.ts';
import type {Options} from 'toastify-js';
2024-12-11 09:29:04 +01:00
import type StartToastifyInstance from 'toastify-js';
export type Toast = ReturnType<typeof StartToastifyInstance>;
2023-06-27 04:45:24 +02:00
type ToastLevels = {
[intent in Intent]: {
icon: SvgName,
background: string,
duration: number,
}
2025-09-14 18:15:06 +02:00
};
const levels: ToastLevels = {
2023-06-27 04:45:24 +02:00
info: {
icon: 'octicon-check',
background: 'var(--color-green)',
duration: 2500,
},
warning: {
icon: 'gitea-exclamation',
background: 'var(--color-orange)',
duration: -1, // requires dismissal to hide
},
error: {
icon: 'gitea-exclamation',
background: 'var(--color-red)',
duration: -1, // requires dismissal to hide
},
};
type ToastOpts = {
useHtmlBody?: boolean,
preventDuplicates?: boolean | string,
} & Options;
2025-09-14 18:15:06 +02:00
type ToastifyElement = HTMLElement & {_giteaToastifyInstance?: Toast};
/** See https://github.com/apvarun/toastify-js#api for options */
2025-10-01 06:43:41 +02:00
function showToast(message: string, level: Intent, {gravity, position, duration, useHtmlBody, preventDuplicates = true, ...other}: ToastOpts = {}): Toast | null {
const body = useHtmlBody ? message : htmlEscape(message);
const parent = document.querySelector('.ui.dimmer.active') ?? document.body;
const duplicateKey = preventDuplicates ? (preventDuplicates === true ? `${level}-${body}` : preventDuplicates) : '';
// prevent showing duplicate toasts with the same level and message, and give visual feedback for end users
if (preventDuplicates) {
const toastEl = parent.querySelector(`:scope > .toastify.on[data-toast-unique-key="${CSS.escape(duplicateKey)}"]`);
if (toastEl) {
2025-12-03 03:13:16 +01:00
const toastDupNumEl = toastEl.querySelector('.toast-duplicate-number')!;
showElem(toastDupNumEl);
toastDupNumEl.textContent = String(Number(toastDupNumEl.textContent) + 1);
animateOnce(toastDupNumEl, 'pulse-1p5-200');
2025-10-01 06:43:41 +02:00
return null;
}
}
2023-06-27 04:45:24 +02:00
const {icon, background, duration: levelDuration} = levels[level ?? 'info'];
const toast = Toastify({
selector: parent,
2023-06-27 04:45:24 +02:00
text: `
<div class='toast-icon'>${svg(icon)}</div>
<div class='toast-body'><span class="toast-duplicate-number tw-hidden">1</span>${body}</div>
<button class='btn toast-close'>${svg('octicon-x')}</button>
2023-06-27 04:45:24 +02:00
`,
escapeMarkup: false,
gravity: gravity ?? 'top',
position: position ?? 'center',
duration: duration ?? levelDuration,
style: {background},
...other,
});
toast.showToast();
2025-12-03 03:13:16 +01:00
const el = toast.toastElement as ToastifyElement;
el.querySelector('.toast-close')!.addEventListener('click', () => toast.hideToast());
el.setAttribute('data-toast-unique-key', duplicateKey);
el._giteaToastifyInstance = toast;
return toast;
2023-06-27 04:45:24 +02:00
}
2025-10-01 06:43:41 +02:00
export function showInfoToast(message: string, opts?: ToastOpts): Toast | null {
2023-08-23 15:25:13 +08:00
return showToast(message, 'info', opts);
2023-06-27 04:45:24 +02:00
}
2025-10-01 06:43:41 +02:00
export function showWarningToast(message: string, opts?: ToastOpts): Toast | null {
2023-08-23 15:25:13 +08:00
return showToast(message, 'warning', opts);
2023-06-27 04:45:24 +02:00
}
2025-10-01 06:43:41 +02:00
export function showErrorToast(message: string, opts?: ToastOpts): Toast | null {
2023-08-23 15:25:13 +08:00
return showToast(message, 'error', opts);
2023-06-27 04:45:24 +02:00
}
function hideToastByElement(el: Element): void {
(el as ToastifyElement)?._giteaToastifyInstance?.hideToast();
}
export function hideToastsFrom(parent: Element): void {
queryElems(parent, ':scope > .toastify.on', hideToastByElement);
}
export function hideToastsAll(): void {
queryElems(document, '.toastify.on', hideToastByElement);
}