@lavalogic/scoria 0.35.0 → 0.37.0

package/dist/Components/SingleSelect.svelte

@@ -1,263 +1,252 @@
-<svelte:options runes />
-
-<script lang="ts" generics="V extends object, VP extends ValueProp<V>">
-	import { devCatch, generateShortUUID, vowels } from '../Helpers/Helpers.svelte.js';
-	import { Colour, ColourSet } from '../scss/colours.js';
-	import type { ValueProp } from '../Types/Internal/Misc.js';
-	import { Size } from '../Types/Internal/Size.js';
-	import Svelecte from 'svelecte';
-	import { onMount, tick } from 'svelte';
-	import Action from './Action.svelte';
-	import type { SingleSelectProps } from './SingleSelectProps.js';
-
-	const {
-		label,
-		options,
-		labelProp,
-		valueProp,
-		focusOnLoad = false,
-		searchable = true,
-		creatable = false,
-
-		createFilter,
-		disabled,
-		width,
-		height,
-		name = 'Item',
-		valueAsObject,
-		minHeight,
-		clearable = false,
-		required = false,
-		invalid = false,
-		borderless = false,
-		lazyDropdown = false,
-		forceUpwards = false,
-		inputId = generateShortUUID(),
-		value: selectedValue,
-		onchange,
-		// onkeydown, // TODO
-		onfocus,
-		onCreateOption
-	}: SingleSelectProps<V, VP> = $props();
-
-	// FIXME this in combination with the effect may trigger a double assignment on mount. We will need to test it.
-
-	let currentValue = $derived(selectedValue);
-	let ref = $state<Svelecte | undefined>();
-	let wrapperRef: HTMLDivElement | undefined = $state();
-
-	$effect.pre(() => {
-		void options;
-		void selectedValue;
-		currentValue = selectedValue;
-	});
-
-	// WARN this is potentially duplicating existing logic
-	// $effect.pre(() => {
-	// 	if (selectedValue) {
-	// 		const found = options.find((opt) => opt[valueProp] === selectedValue[valueProp]);
-	// 		debugger;
-	// 		if (!found) {
-	// 			onCreateOption?.(selectedValue);
-	// 		} else {
-	// 			console.log(options);
-	// 		}
-	// 	}
-	// });
-
-	const an = $derived(name && vowels.has(name.at(0)?.toLocaleLowerCase() ?? '') ? 'an' : 'a');
-
-	const isInvalid = $derived((required && !currentValue) || invalid);
-
-	let hasAutoFocused = $state(false);
-	const dropdownBottom = $derived(wrapperRef ? wrapperRef.getBoundingClientRect().height : 0);
-
-	function forceShowDropdown(input: HTMLInputElement) {
-		if (focusOnLoad && !hasAutoFocused) {
-			hasAutoFocused = true;
-
-			input.click();
-
-			// HACK. the default selectOnTab functionality selects the highlighted element,
-			// this selects the first element on the list
-			// please decide which one we'll be using and be consistent
-			// input.addEventListener('keydown', (e) => {
-			// 	onkeydown(e)
-			// if (e.key === 'Tab') {
-			// 	const inputElement = e.target as HTMLInputElement | undefined;
-			// 	if (inputElement && inputElement.value.trim()) {
-			// 		(
-			// 			inputElement?.parentElement?.parentElement?.parentElement?.parentElement?.querySelector(
-			// 				'[data-pos="0"]' //first element from dropdown
-			// 			) as HTMLElement | undefined
-			// 		)?.click();
-			// 	} else if (optional) {
-			// 		dispatch('change', null);
-			// 	}
-			// }
-			// });
-		}
-	}
-
-	// let hidden = $state(false);
-	let isExpanded = $state(false);
-
-	onMount(() => {
-		if (focusOnLoad) {
-			tick()
-				.then(() => {
-					(ref as HTMLSelectElement | undefined)?.focus();
-				})
-				.catch(devCatch);
-		}
-
-		const input = document.getElementById(inputId);
-		// input?.addEventListener('focus', () => {
-		// 	hidden = true;
-		// });
-		// input?.addEventListener('blur', () => {
-		// 	hidden = false;
-		// });
-
-		// HACK callback for is-open on/off
-		const dropdownRef = input?.closest('div.svelecte')?.querySelector('.sv_dropdown') ?? undefined;
-		const observer = new MutationObserver((mutations: Array<MutationRecord>) => {
-			for (let i = mutations.length - 1; i > -1; i--) {
-				const mutation = mutations[i];
-				if (mutation.attributeName === 'class') {
-					isExpanded = dropdownRef?.classList.contains('is-open') ?? false;
-				}
-			}
-		});
-
-		if (dropdownRef) {
-			observer.observe(dropdownRef, { attributes: true });
-		}
-
-		return () => {
-			observer.disconnect();
-		};
-	});
-
-	// function onChange(v: V | null) {
-	// 	if (clearable || v != null) {
-	// 		onchange(v ?? null);
-	// 	} else {
-	// 		currentValue = null;
-	// 		currentValue = selectedValue;
-	// 	}
-	// }
-
-	function isObject(value: SingleSelectProps<V, VP>['value']): value is V | null {
-		return typeof value == 'object';
-	}
-</script>
-
-<div
-	class="select-wrapper"
-	class:no-border={borderless}
-	style={`${width ? `--input-width: ${width};` : ''}${height ? `--input-height: ${height};` : ''} --dropdown-bottom: calc(${dropdownBottom}px + 1px); --sv-min-height: ${minHeight ?? '2rem'};`}
-	class:invalid={isInvalid}
-	class:force-upwards={forceUpwards}
-	bind:this={wrapperRef}
->
-	{#if label}
-		<label for={inputId}>
-			<span
-				>{label}{#if !required}&nbsp;- <i>optional</i>{/if}</span
-			>
-			<span class="border"
-				>{label}{#if !required}&nbsp;- <i>optional</i>{/if}</span
-			>
-		</label>
-	{/if}
-
-	<Svelecte
-		{createFilter}
-		{disabled}
-		{name}
-		onFocus={(target: HTMLInputElement) => {
-			forceShowDropdown(target);
-			onfocus?.(target);
-		}}
-		bind:this={ref}
-		{valueAsObject}
-		{inputId}
-		{required}
-		valueField={valueProp}
-		labelField={labelProp}
-		virtualList={false}
-		{options}
-		{creatable}
-		searchProps={{ keepSelectionInList: true }}
-		{onCreateOption}
-		placeholder="Please Select {name ? `${an} ${name}` : ''}"
-		{lazyDropdown}
-		value={// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		currentValue as Array<any>}
-		onChange={onchange}
-		{searchable}
-		selectOnTab
-		keepSelectionInList
-		deselectMode={clearable ? 'toggle' : 'none'}
-	>
-		{#snippet option(opt)}<span class="dropdown-item"> {(opt as V)[labelProp]}</span>{/snippet}
-
-		{#snippet append()}
-			<div class="icons">
-				{#if clearable && currentValue}
-					<Action
-						noTabIndex
-						onclick={(e: MouseEvent) => {
-							if (isExpanded) {
-								e.stopPropagation();
-							}
-
-							onchange(null);
-						}}
-						{disabled}
-						colourSet={ColourSet.Auxiliary}
-						size={Size.Small}
-						icon={{
-							name: 'close-menu-cross',
-							colour: Colour['$ui-blue-10']
-						}}
-					/>
-				{/if}
-
-				<Action
-					noTabIndex
-					colourSet={ColourSet.Auxiliary}
-					size={Size.Small}
-					{disabled}
-					icon={{
-						name: isExpanded ? 'chevron-up' : 'chevron-down',
-						colour: Colour['$ui-blue-10']
-					}}
-				/>
-			</div>
-		{/snippet}
-		{#snippet toggleIcon()}
-			<div class="nothing"></div>
-			<!-- <div class="icon-bg">
-				<Icon name="chevron-down" size={Size.MediumSmall} />
-			</div> -->
-		{/snippet}
-
-		{#snippet selection(/*_selectedOptions: Array<any>*/)}
-			<!-- <span class="selection">hello</span> -->
-
-			<span class="selection" class:invalid={isInvalid}>
-				{#if isObject(selectedValue)}
-					{selectedValue?.[labelProp]}
-				{:else}
-					{options.find((it) => it[valueProp] === selectedValue)?.[labelProp]}
-				{/if}
-			</span>
-		{/snippet}
-	</Svelecte>
-</div>
-
+<svelte:options runes />
+
+<script
+	lang="ts"
+	generics="V extends object, VP extends ValueProp<V>"
+>
+	import { devCatch, generateWeakId, vowels } from '../Helpers/Helpers.svelte.js';
+	import { attachDropdownPortal } from '../Helpers/dropdownPortal.js';
+	import { Colour, ColourSet } from '../scss/colours.js';
+	import type { ValueProp } from '../Types/Internal/Misc.js';
+	import { Size } from '../Types/Internal/Size.js';
+	import Svelecte from 'svelecte';
+	import { onMount, tick } from 'svelte';
+	import Action from './Action.svelte';
+	import type { SingleSelectProps } from './SingleSelectProps.js';
+
+	const {
+		label,
+		options,
+		labelProp,
+		valueProp,
+		focusOnLoad = false,
+		searchable = true,
+		creatable = false,
+
+		createFilter,
+		disabled,
+		width,
+		height,
+		name = 'Item',
+		valueAsObject,
+		minHeight,
+		clearable = false,
+		required = false,
+		invalid = false,
+		borderless = false,
+		lazyDropdown = false,
+		forceUpwards = false,
+		inputId = generateWeakId(),
+		value: selectedValue,
+		onchange,
+		onfocus,
+		onCreateOption,
+	}: SingleSelectProps<V, VP> = $props();
+
+	// Single source of truth for the current value. The previous code mixed
+	// `$derived` and `$effect.pre`, which fired a redundant assignment on mount.
+	const currentValue = $derived(selectedValue);
+	let ref = $state<Svelecte | undefined>();
+	let wrapperRef: HTMLDivElement | undefined = $state();
+
+	const an = $derived(name && vowels.has(name.at(0)?.toLocaleLowerCase() ?? '') ? 'an' : 'a');
+
+	const isInvalid = $derived((required && !currentValue) || invalid);
+
+	let hasAutoFocused = $state(false);
+
+	// ResizeObserver-driven height. Replaces the layout-forcing
+	// `getBoundingClientRect()` call that used to run inside a `$derived`.
+	let dropdownBottom = $state(0);
+	$effect(() => {
+		if (!wrapperRef) {
+			return;
+		}
+		const ro = new ResizeObserver((entries) => {
+			const entry = entries[0];
+			dropdownBottom = entry.borderBoxSize[0].blockSize;
+		});
+		ro.observe(wrapperRef);
+		return () => {
+			ro.disconnect();
+		};
+	});
+
+	function forceShowDropdown(input: HTMLInputElement) {
+		if (focusOnLoad && !hasAutoFocused) {
+			hasAutoFocused = true;
+			input.click();
+		}
+	}
+
+	let isExpanded = $state(false);
+
+	onMount(() => {
+		if (focusOnLoad) {
+			tick()
+				.then(() => {
+					(ref as HTMLSelectElement | undefined)?.focus();
+				})
+				.catch(devCatch);
+		}
+
+		const input = document.getElementById(inputId);
+		const svelecteRoot = input?.closest('div.svelecte') as HTMLElement | null;
+		const dropdownRef =
+			(svelecteRoot?.querySelector('.sv_dropdown') as HTMLElement | null) ?? undefined;
+
+		// HACK callback for is-open on/off. Drives the chevron
+		// rotation / clear icon visibility below.
+		const observer = new MutationObserver((mutations: Array<MutationRecord>) => {
+			for (let i = mutations.length - 1; i > -1; i--) {
+				const mutation = mutations[i];
+				if (mutation.attributeName === 'class') {
+					isExpanded = dropdownRef?.classList.contains('is-open') ?? false;
+				}
+			}
+		});
+
+		if (dropdownRef) {
+			observer.observe(dropdownRef, { attributes: true });
+		}
+
+		// Teleport the dropdown to `document.body` while open so it
+		// escapes every ancestor `overflow` / `transform` / `z-index`
+		// stacking context (filter-panel groups, sticky table strips,
+		// modals, etc.). The portal helper also auto-flips upwards
+		// when there is not enough space below the trigger and
+		// repositions on scroll / resize. See
+		// `Helpers/dropdownPortal.ts` for the full rationale.
+		const detachPortal = attachDropdownPortal({
+			getTrigger: () => svelecteRoot,
+			getDropdown: () => dropdownRef,
+		});
+
+		return () => {
+			observer.disconnect();
+			detachPortal();
+		};
+	});
+
+	function isObject(value: SingleSelectProps<V, VP>['value']): value is V {
+		return value !== null && typeof value === 'object';
+	}
+</script>
+
+<div
+	class="select-wrapper"
+	class:no-border={borderless}
+	style={`${width ? `--input-width: ${width};` : ''}${height ? `--input-height: ${height};` : ''} --dropdown-bottom: calc(${dropdownBottom}px + 1px); --sv-min-height: ${minHeight ?? '2rem'};`}
+	class:invalid={isInvalid}
+	class:force-upwards={forceUpwards}
+	bind:this={wrapperRef}
+>
+	{#if label}
+		<label for={inputId}>
+			<span
+				>{label}{#if !required}&nbsp;- <i>optional</i>{/if}</span
+			>
+			<span class="border"
+				>{label}{#if !required}&nbsp;- <i>optional</i>{/if}</span
+			>
+		</label>
+	{/if}
+
+	<Svelecte
+		{createFilter}
+		{disabled}
+		{name}
+		onFocus={(target: HTMLInputElement) => {
+			forceShowDropdown(target);
+			onfocus?.(target);
+		}}
+		bind:this={ref}
+		{valueAsObject}
+		{inputId}
+		{required}
+		valueField={valueProp}
+		labelField={labelProp}
+		virtualList={false}
+		{options}
+		{creatable}
+		searchProps={{ keepSelectionInList: true }}
+		{onCreateOption}
+		placeholder="Please Select {name ? `${an} ${name}` : ''}"
+		{lazyDropdown}
+		value={// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		currentValue as Array<any>}
+		onChange={(newValue: V | null) => {
+			// svelecte always emits the full option object regardless of
+			// `valueAsObject`. Map to the shape the discriminated variant
+			// promised: primitive for AsPrimitive, object for AsObject.
+			if (valueAsObject) {
+				void (onchange as (v: V | null) => void | Promise<void>)(newValue);
+			} else {
+				const primitive = newValue == null ? null : newValue[valueProp];
+				// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+				void (onchange as (v: V[VP] | null) => void | Promise<void>)(primitive);
+			}
+		}}
+		{searchable}
+		selectOnTab
+		keepSelectionInList
+		deselectMode={clearable ? 'toggle' : 'none'}
+	>
+		{#snippet option(opt)}<span class="dropdown-item"> {(opt as V)[labelProp]}</span>{/snippet}
+
+		{#snippet append()}
+			<div class="icons">
+				{#if clearable && currentValue}
+					<Action
+						noTabIndex
+						onclick={(e: MouseEvent) => {
+							if (isExpanded) {
+								e.stopPropagation();
+							}
+
+							void onchange(null);
+						}}
+						{disabled}
+						colourSet={ColourSet.Auxiliary}
+						size={Size.Small}
+						icon={{
+							name: 'close-menu-cross',
+							colour: Colour['$ui-blue-10'],
+						}}
+					/>
+				{/if}
+
+				<Action
+					noTabIndex
+					colourSet={ColourSet.Auxiliary}
+					size={Size.Small}
+					{disabled}
+					icon={{
+						name: isExpanded ? 'chevron-up' : 'chevron-down',
+						colour: Colour['$ui-blue-10'],
+					}}
+				/>
+			</div>
+		{/snippet}
+		{#snippet toggleIcon()}
+			<div class="nothing"></div>
+		{/snippet}
+
+		{#snippet selection(/*_selectedOptions: Array<any>*/)}
+			<span
+				class="selection"
+				class:invalid={isInvalid}
+			>
+				{#if isObject(selectedValue)}
+					{selectedValue[labelProp]}
+				{:else}
+					{options.find((it) => it[valueProp] === selectedValue)?.[labelProp]}
+				{/if}
+			</span>
+		{/snippet}
+	</Svelecte>
+</div>
+
 <style>.select-wrapper {
   min-width: var(--input-min-width, 12rem);
   width: var(--input-width, 100%);
@@ -326,24 +315,13 @@
   max-height: 100%;
   box-sizing: border-box;
 }
-.select-wrapper :global(.sv-item--content) {
-  font-size: 0.875rem;
-}
-.select-wrapper :global(.sv-item--wrap.in-dropdown) {
-  cursor: pointer;
-  min-height: 40px;
-  align-items: center;
-}
-.select-wrapper :global(.sv-item--content) {
-  min-height: 1.2rem;
-}
 .select-wrapper :global(.sv-btn-indicator) {
   cursor: pointer;
 }
 .select-wrapper.no-border {
   --sv-border: none;
 }
-.select-wrapper .select-wrapper.force-upwards :global .sv_dropdown.is-open {
+.select-wrapper.force-upwards :global .sv_dropdown.is-open {
   bottom: var(--dropdown-bottom);
 }
 .select-wrapper :global .sv-control {
@@ -364,32 +342,18 @@
 .select-wrapper :global .svelecte.svelecte-control {
   cursor: pointer;
 }
-.select-wrapper :global .sv-item--wrap.in-dropdown {
-  cursor: pointer;
-  min-height: 40px;
-  align-items: center;
-}
-.select-wrapper :global .sv-item--content {
-  min-height: 1.2rem;
-}
 .select-wrapper :global span {
   transition: border-color ease-out 0.15s 0s, background-color ease-out 0.15s 0s, color ease-out 0.15s 0s, fill ease-out 0.15s 0s;
 }
 .select-wrapper :global .sv-control {
   transition: border-color ease-out 0.15s 0s, background-color ease-out 0.15s 0s, color ease-out 0.15s 0s, fill ease-out 0.15s 0s;
 }
-.select-wrapper :global div.sv_dropdown.is-open {
-  z-index: 99;
-}
 .select-wrapper div.nothing {
   height: 0;
   width: 0;
 }
-.select-wrapper .dropdown-item,
 .select-wrapper .selection {
   font-size: 0.875rem;
-}
-.select-wrapper .selection {
   padding-left: 0.5rem;
   white-space: nowrap;
   display: flex;
@@ -413,22 +377,36 @@ div.icons {
   box-sizing: border-box;
 }
 
-.dropdown-item {
+:global .sv-item--wrap.in-dropdown {
+  cursor: pointer;
+  min-height: 40px;
+  align-items: center;
+}
+:global .sv-item--content {
+  font-size: 0.875rem;
+  min-height: 1.2rem;
+}
+:global div.sv_dropdown.is-open {
+  z-index: 99;
+}
+
+:global(.dropdown-item) {
   display: flex;
   flex-flow: row nowrap;
   width: 100%;
   overflow: hidden;
   text-overflow: ellipsis;
   gap: 1rem;
+  font-size: 0.875rem;
   fill: #259fc7;
 }
-.dropdown-item .toggle-icon {
+:global(.dropdown-item) .toggle-icon {
   display: flex;
   align-items: center;
   justify-content: center;
   flex-flow: column nowrap;
   opacity: 0;
 }
-.dropdown-item .toggle-icon.yes {
+:global(.dropdown-item) .toggle-icon.yes {
   opacity: 1;
-}</style>
+}</style>