summaryrefslogtreecommitdiff
path: root/source/helpers/attach-element.ts
blob: 0703febcd62ffbcf45508b8608b52c6a435783d5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
import {$, $$, elementExists} from 'select-dom';
import {RequireAtLeastOne} from 'type-fest';
import {isDefined} from 'ts-extras';

import getCallerID from './caller-id.js';

type Position = 'append' | 'prepend' | 'before' | 'after' | 'forEach';

// NOTE: Do not turn the Callback into an async function or else the deduplication won't work. A placeholder element MUST be returned synchronously. The deduplication logic is DOM-based.
type Attachment<NewElement extends Element, Callback = (E: Element) => NewElement> = RequireAtLeastOne<{
	className?: string;
	append: Callback;
	prepend: Callback;
	before: Callback;
	after: Callback;
	forEach: Callback;
	allowMissingAnchor?: boolean;
}, Position>;

export default function attachElement<NewElement extends Element>(
	// eslint-disable-next-line @typescript-eslint/ban-types --  Allows dom traversing without requiring `!`
	anchor: Element | string | undefined | null,
	{
		className = 'rgh-' + getCallerID(),
		append,
		prepend,
		before,
		after,
		forEach,
		allowMissingAnchor = false,
	}: Attachment<NewElement>): NewElement[] {
	const anchorElement = typeof anchor === 'string' ? $(anchor) : anchor;
	if (!anchorElement) {
		if (allowMissingAnchor) {
			return [];
		}

		throw new Error('Element not found');
	}

	if (elementExists('.' + className, anchorElement.parentElement ?? anchorElement)) {
		return [];
	}

	const call = (position: Position, create: (anchorElement: Element) => NewElement): NewElement => {
		const element = create(anchorElement);
		element.classList.add(className);

		// Attach the created element, unless the callback already took care of that
		if (position !== 'forEach') {
			anchorElement[position](element);
		}

		return element;
	};

	return [
		append && call('append', append),
		prepend && call('prepend', prepend),
		before && call('before', before),
		after && call('after', after),
		forEach && call('forEach', forEach),
		// eslint-disable-next-line unicorn/no-array-callback-reference -- It only works this way. TS, AMIRITE?
	].filter(isDefined);
}

export function attachElements<NewElement extends Element>(anchors: string | string[], {
	className = 'rgh-' + getCallerID(),
	...options
}: Attachment<NewElement>): NewElement[] {
	return $$(`:is(${String(anchors)}):not(.${className})`)
		.flatMap(anchor => attachElement(anchor, {...options, className}));
}