mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-15 09:32:19 +08:00
5a50b271e7
See the comment of isInFrontendUnitTest
364 lines
14 KiB
TypeScript
364 lines
14 KiB
TypeScript
import {debounce} from 'throttle-debounce';
|
|
import type {Promisable} from 'type-fest';
|
|
import type $ from 'jquery';
|
|
import {isInFrontendUnitTest} from './testhelper.ts';
|
|
|
|
type ArrayLikeIterable<T> = ArrayLike<T> & Iterable<T>; // for NodeListOf and Array
|
|
type ElementArg = Element | string | ArrayLikeIterable<Element> | ReturnType<typeof $>;
|
|
type ElementsCallback<T extends Element> = (el: T) => Promisable<any>;
|
|
type ElementsCallbackWithArgs = (el: Element, ...args: any[]) => Promisable<any>;
|
|
|
|
function elementsCall(el: ElementArg, func: ElementsCallbackWithArgs, ...args: any[]) {
|
|
if (typeof el === 'string' || el instanceof String) {
|
|
el = document.querySelectorAll(el as string);
|
|
}
|
|
if (el instanceof Node) {
|
|
func(el, ...args);
|
|
} else if (el.length !== undefined) {
|
|
// this works for: NodeList, HTMLCollection, Array, jQuery
|
|
for (const e of (el as ArrayLikeIterable<Element>)) {
|
|
func(e, ...args);
|
|
}
|
|
} else {
|
|
throw new Error('invalid argument to be shown/hidden');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param el Element
|
|
* @param force force=true to show or force=false to hide, undefined to toggle
|
|
*/
|
|
function toggleShown(el: Element, force: boolean) {
|
|
if (force === true) {
|
|
el.classList.remove('tw-hidden');
|
|
} else if (force === false) {
|
|
el.classList.add('tw-hidden');
|
|
} else if (force === undefined) {
|
|
el.classList.toggle('tw-hidden');
|
|
} else {
|
|
throw new Error('invalid force argument');
|
|
}
|
|
}
|
|
|
|
export function showElem(el: ElementArg) {
|
|
elementsCall(el, toggleShown, true);
|
|
}
|
|
|
|
export function hideElem(el: ElementArg) {
|
|
elementsCall(el, toggleShown, false);
|
|
}
|
|
|
|
export function toggleElem(el: ElementArg, force?: boolean) {
|
|
elementsCall(el, toggleShown, force);
|
|
}
|
|
|
|
export function isElemHidden(el: ElementArg) {
|
|
const res: boolean[] = [];
|
|
elementsCall(el, (e) => res.push(e.classList.contains('tw-hidden')));
|
|
if (res.length > 1) throw new Error(`isElemHidden doesn't work for multiple elements`);
|
|
return res[0];
|
|
}
|
|
|
|
function applyElemsCallback<T extends Element>(elems: ArrayLikeIterable<T>, fn?: ElementsCallback<T>): ArrayLikeIterable<T> {
|
|
if (fn) {
|
|
for (const el of elems) {
|
|
fn(el);
|
|
}
|
|
}
|
|
return elems;
|
|
}
|
|
|
|
export function queryElemSiblings<T extends Element>(el: Element, selector = '*', fn?: ElementsCallback<T>): ArrayLikeIterable<T> {
|
|
const elems = Array.from(el.parentNode.children) as T[];
|
|
return applyElemsCallback<T>(elems.filter((child: Element) => {
|
|
return child !== el && child.matches(selector);
|
|
}), fn);
|
|
}
|
|
|
|
// it works like jQuery.children: only the direct children are selected
|
|
export function queryElemChildren<T extends Element>(parent: Element | ParentNode, selector = '*', fn?: ElementsCallback<T>): ArrayLikeIterable<T> {
|
|
if (isInFrontendUnitTest()) {
|
|
// https://github.com/capricorn86/happy-dom/issues/1620 : ":scope" doesn't work
|
|
const selected = Array.from<T>(parent.children as any).filter((child) => child.matches(selector));
|
|
return applyElemsCallback<T>(selected, fn);
|
|
}
|
|
return applyElemsCallback<T>(parent.querySelectorAll(`:scope > ${selector}`), fn);
|
|
}
|
|
|
|
// it works like parent.querySelectorAll: all descendants are selected
|
|
// in the future, all "queryElems(document, ...)" should be refactored to use a more specific parent
|
|
export function queryElems<T extends Element>(parent: Element | ParentNode, selector: string, fn?: ElementsCallback<T>): ArrayLikeIterable<T> {
|
|
return applyElemsCallback<T>(parent.querySelectorAll(selector), fn);
|
|
}
|
|
|
|
export function onDomReady(cb: () => Promisable<void>) {
|
|
if (document.readyState === 'loading') {
|
|
document.addEventListener('DOMContentLoaded', cb);
|
|
} else {
|
|
cb();
|
|
}
|
|
}
|
|
|
|
// checks whether an element is owned by the current document, and whether it is a document fragment or element node
|
|
// if it is, it means it is a "normal" element managed by us, which can be modified safely.
|
|
export function isDocumentFragmentOrElementNode(el: Node) {
|
|
try {
|
|
return el.ownerDocument === document && el.nodeType === Node.ELEMENT_NODE || el.nodeType === Node.DOCUMENT_FRAGMENT_NODE;
|
|
} catch {
|
|
// in case the el is not in the same origin, then the access to nodeType would fail
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// autosize a textarea to fit content. Based on
|
|
// https://github.com/github/textarea-autosize
|
|
// ---------------------------------------------------------------------
|
|
// Copyright (c) 2018 GitHub, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining
|
|
// a copy of this software and associated documentation files (the
|
|
// "Software"), to deal in the Software without restriction, including
|
|
// without limitation the rights to use, copy, modify, merge, publish,
|
|
// distribute, sublicense, and/or sell copies of the Software, and to
|
|
// permit persons to whom the Software is furnished to do so, subject to
|
|
// the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be
|
|
// included in all copies or substantial portions of the Software.
|
|
// ---------------------------------------------------------------------
|
|
export function autosize(textarea: HTMLTextAreaElement, {viewportMarginBottom = 0}: {viewportMarginBottom?: number} = {}) {
|
|
let isUserResized = false;
|
|
// lastStyleHeight and initialStyleHeight are CSS values like '100px'
|
|
let lastMouseX: number;
|
|
let lastMouseY: number;
|
|
let lastStyleHeight: string;
|
|
let initialStyleHeight: string;
|
|
|
|
function onUserResize(event: MouseEvent) {
|
|
if (isUserResized) return;
|
|
if (lastMouseX !== event.clientX || lastMouseY !== event.clientY) {
|
|
const newStyleHeight = textarea.style.height;
|
|
if (lastStyleHeight && lastStyleHeight !== newStyleHeight) {
|
|
isUserResized = true;
|
|
}
|
|
lastStyleHeight = newStyleHeight;
|
|
}
|
|
|
|
lastMouseX = event.clientX;
|
|
lastMouseY = event.clientY;
|
|
}
|
|
|
|
function overflowOffset() {
|
|
let offsetTop = 0;
|
|
let el = textarea;
|
|
|
|
while (el !== document.body && el !== null) {
|
|
offsetTop += el.offsetTop || 0;
|
|
el = el.offsetParent as HTMLTextAreaElement;
|
|
}
|
|
|
|
const top = offsetTop - document.defaultView.scrollY;
|
|
const bottom = document.documentElement.clientHeight - (top + textarea.offsetHeight);
|
|
return {top, bottom};
|
|
}
|
|
|
|
function resizeToFit() {
|
|
if (isUserResized) return;
|
|
if (textarea.offsetWidth <= 0 && textarea.offsetHeight <= 0) return;
|
|
|
|
try {
|
|
const {top, bottom} = overflowOffset();
|
|
const isOutOfViewport = top < 0 || bottom < 0;
|
|
|
|
const computedStyle = getComputedStyle(textarea);
|
|
const topBorderWidth = parseFloat(computedStyle.borderTopWidth);
|
|
const bottomBorderWidth = parseFloat(computedStyle.borderBottomWidth);
|
|
const isBorderBox = computedStyle.boxSizing === 'border-box';
|
|
const borderAddOn = isBorderBox ? topBorderWidth + bottomBorderWidth : 0;
|
|
|
|
const adjustedViewportMarginBottom = Math.min(bottom, viewportMarginBottom);
|
|
const curHeight = parseFloat(computedStyle.height);
|
|
const maxHeight = curHeight + bottom - adjustedViewportMarginBottom;
|
|
|
|
textarea.style.height = 'auto';
|
|
let newHeight = textarea.scrollHeight + borderAddOn;
|
|
|
|
if (isOutOfViewport) {
|
|
// it is already out of the viewport:
|
|
// * if the textarea is expanding: do not resize it
|
|
if (newHeight > curHeight) {
|
|
newHeight = curHeight;
|
|
}
|
|
// * if the textarea is shrinking, shrink line by line (just use the
|
|
// scrollHeight). do not apply max-height limit, otherwise the page
|
|
// flickers and the textarea jumps
|
|
} else {
|
|
// * if it is in the viewport, apply the max-height limit
|
|
newHeight = Math.min(maxHeight, newHeight);
|
|
}
|
|
|
|
textarea.style.height = `${newHeight}px`;
|
|
lastStyleHeight = textarea.style.height;
|
|
} finally {
|
|
// ensure that the textarea is fully scrolled to the end, when the cursor
|
|
// is at the end during an input event
|
|
if (textarea.selectionStart === textarea.selectionEnd &&
|
|
textarea.selectionStart === textarea.value.length) {
|
|
textarea.scrollTop = textarea.scrollHeight;
|
|
}
|
|
}
|
|
}
|
|
|
|
function onFormReset() {
|
|
isUserResized = false;
|
|
if (initialStyleHeight !== undefined) {
|
|
textarea.style.height = initialStyleHeight;
|
|
} else {
|
|
textarea.style.removeProperty('height');
|
|
}
|
|
}
|
|
|
|
textarea.addEventListener('mousemove', onUserResize);
|
|
textarea.addEventListener('input', resizeToFit);
|
|
textarea.form?.addEventListener('reset', onFormReset);
|
|
initialStyleHeight = textarea.style.height ?? undefined;
|
|
if (textarea.value) resizeToFit();
|
|
|
|
return {
|
|
resizeToFit,
|
|
destroy() {
|
|
textarea.removeEventListener('mousemove', onUserResize);
|
|
textarea.removeEventListener('input', resizeToFit);
|
|
textarea.form?.removeEventListener('reset', onFormReset);
|
|
},
|
|
};
|
|
}
|
|
|
|
export function onInputDebounce(fn: () => Promisable<any>) {
|
|
return debounce(300, fn);
|
|
}
|
|
|
|
type LoadableElement = HTMLEmbedElement | HTMLIFrameElement | HTMLImageElement | HTMLScriptElement | HTMLTrackElement;
|
|
|
|
// Set the `src` attribute on an element and returns a promise that resolves once the element
|
|
// has loaded or errored.
|
|
export function loadElem(el: LoadableElement, src: string) {
|
|
return new Promise((resolve) => {
|
|
el.addEventListener('load', () => resolve(true), {once: true});
|
|
el.addEventListener('error', () => resolve(false), {once: true});
|
|
el.src = src;
|
|
});
|
|
}
|
|
|
|
// some browsers like PaleMoon don't have "SubmitEvent" support, so polyfill it by a tricky method: use the last clicked button as submitter
|
|
// it can't use other transparent polyfill patches because PaleMoon also doesn't support "addEventListener(capture)"
|
|
const needSubmitEventPolyfill = typeof SubmitEvent === 'undefined';
|
|
|
|
export function submitEventSubmitter(e) {
|
|
e = e.originalEvent ?? e; // if the event is wrapped by jQuery, use "originalEvent", otherwise, use the event itself
|
|
return needSubmitEventPolyfill ? (e.target._submitter || null) : e.submitter;
|
|
}
|
|
|
|
function submitEventPolyfillListener(e) {
|
|
const form = e.target.closest('form');
|
|
if (!form) return;
|
|
form._submitter = e.target.closest('button:not([type]), button[type="submit"], input[type="submit"]');
|
|
}
|
|
|
|
export function initSubmitEventPolyfill() {
|
|
if (!needSubmitEventPolyfill) return;
|
|
console.warn(`This browser doesn't have "SubmitEvent" support, use a tricky method to polyfill`);
|
|
document.body.addEventListener('click', submitEventPolyfillListener);
|
|
document.body.addEventListener('focus', submitEventPolyfillListener);
|
|
}
|
|
|
|
/**
|
|
* Check if an element is visible, equivalent to jQuery's `:visible` pseudo.
|
|
* Note: This function doesn't account for all possible visibility scenarios.
|
|
*/
|
|
export function isElemVisible(element: HTMLElement): boolean {
|
|
if (!element) return false;
|
|
// checking element.style.display is not necessary for browsers, but it is required by some tests with happy-dom because happy-dom doesn't really do layout
|
|
return Boolean((element.offsetWidth || element.offsetHeight || element.getClientRects().length) && element.style.display !== 'none');
|
|
}
|
|
|
|
// replace selected text in a textarea while preserving editor history, e.g. CTRL-Z works after this
|
|
export function replaceTextareaSelection(textarea: HTMLTextAreaElement, text: string) {
|
|
const before = textarea.value.slice(0, textarea.selectionStart ?? undefined);
|
|
const after = textarea.value.slice(textarea.selectionEnd ?? undefined);
|
|
let success = true;
|
|
|
|
textarea.contentEditable = 'true';
|
|
try {
|
|
success = document.execCommand('insertText', false, text); // eslint-disable-line @typescript-eslint/no-deprecated
|
|
} catch {
|
|
success = false;
|
|
}
|
|
textarea.contentEditable = 'false';
|
|
|
|
if (success && !textarea.value.slice(0, textarea.selectionStart ?? undefined).endsWith(text)) {
|
|
success = false;
|
|
}
|
|
|
|
if (!success) {
|
|
textarea.value = `${before}${text}${after}`;
|
|
textarea.dispatchEvent(new CustomEvent('change', {bubbles: true, cancelable: true}));
|
|
}
|
|
}
|
|
|
|
// Warning: Do not enter any unsanitized variables here
|
|
export function createElementFromHTML<T extends HTMLElement>(htmlString: string): T {
|
|
htmlString = htmlString.trim();
|
|
// some tags like "tr" are special, it must use a correct parent container to create
|
|
if (htmlString.startsWith('<tr')) {
|
|
const container = document.createElement('table');
|
|
container.innerHTML = htmlString;
|
|
return container.querySelector<T>('tr');
|
|
}
|
|
const div = document.createElement('div');
|
|
div.innerHTML = htmlString;
|
|
return div.firstChild as T;
|
|
}
|
|
|
|
export function createElementFromAttrs(tagName: string, attrs: Record<string, any>, ...children: (Node|string)[]): HTMLElement {
|
|
const el = document.createElement(tagName);
|
|
for (const [key, value] of Object.entries(attrs || {})) {
|
|
if (value === undefined || value === null) continue;
|
|
if (typeof value === 'boolean') {
|
|
el.toggleAttribute(key, value);
|
|
} else {
|
|
el.setAttribute(key, String(value));
|
|
}
|
|
}
|
|
for (const child of children) {
|
|
el.append(child instanceof Node ? child : document.createTextNode(child));
|
|
}
|
|
return el;
|
|
}
|
|
|
|
export function animateOnce(el: Element, animationClassName: string): Promise<void> {
|
|
return new Promise((resolve) => {
|
|
el.addEventListener('animationend', function onAnimationEnd() {
|
|
el.classList.remove(animationClassName);
|
|
el.removeEventListener('animationend', onAnimationEnd);
|
|
resolve();
|
|
}, {once: true});
|
|
el.classList.add(animationClassName);
|
|
});
|
|
}
|
|
|
|
export function querySingleVisibleElem<T extends HTMLElement>(parent: Element, selector: string): T | null {
|
|
const elems = parent.querySelectorAll<HTMLElement>(selector);
|
|
const candidates = Array.from(elems).filter(isElemVisible);
|
|
if (candidates.length > 1) throw new Error(`Expected exactly one visible element matching selector "${selector}", but found ${candidates.length}`);
|
|
return candidates.length ? candidates[0] as T : null;
|
|
}
|
|
|
|
export function addDelegatedEventListener<T extends HTMLElement, E extends Event>(parent: Node, type: string, selector: string, listener: (elem: T, e: E) => void | Promise<any>, options?: boolean | AddEventListenerOptions) {
|
|
parent.addEventListener(type, (e: Event) => {
|
|
const elem = (e.target as HTMLElement).closest(selector);
|
|
if (!elem) return;
|
|
listener(elem as T, e as E);
|
|
}, options);
|
|
}
|