@lavalogic/scoria 0.35.0 → 0.37.0

package/dist/Components/Touch/TouchModal.svelte

@@ -1,261 +1,267 @@
-<!-- eslint-disable prefer-const  -->
-<svelte:options runes />
-
-<script lang="ts">
-	import { DATAMatrix } from '../../Helpers/Datamatrix.js';
-	import { passthrough } from '../../Helpers/Helpers.svelte.js';
-	import { ColourSet } from '../../scss/colours.js';
-	import { Size } from '../../Types/Internal/Size.js';
-	import { onMount } from 'svelte';
-	import Action from '../Action.svelte';
-	import DataMatrixIcon from '../DataMatrixIcon.svelte';
-	import type { TouchModalProps } from './TouchModalProps.js';
-
-	let {
-		header,
-		buttons,
-		mandatory = false,
-		staticHeight = false,
-		staticWidth = false,
-		minWidth = '400px',
-		minHeight = '280px',
-		width,
-		height,
-		onShowCallback,
-		defaultTimer,
-		isValid = true,
-		noscroll = false,
-		onsubmit,
-		headerExtra,
-		explanation,
-		children,
-		footer,
-		onclose,
-		row,
-		wrap,
-		submitRef = $bindable(),
-	}: TouchModalProps = $props();
-
-	let dialog: HTMLDialogElement | undefined;
-	let form: HTMLFormElement;
-	let timeout: ReturnType<typeof setTimeout> | undefined = undefined;
-	let paused = $state(false);
-
-	$effect(() => {
-		if (dialog) {
-			dialog.showModal();
-			onShowCallback?.();
-		}
-	});
-
-	let isActive = false;
-
-	onMount(() => {
-		setTimeout(() => {
-			isActive = true;
-		}, 200);
-
-		if (defaultTimer) {
-			timeout = setTimeout(() => {
-				if (dialog && dialog.open) {
-					if (defaultTimer.action === 'submit') {
-						form.requestSubmit();
-						defaultTimer.callback?.();
-					} else {
-						dialog.close();
-					}
-				}
-			}, defaultTimer.time);
-		}
-
-		return clearTimer;
-	});
-
-	function clearTimer() {
-		if (timeout != undefined) {
-			paused = true;
-			clearTimeout(timeout);
-		}
-	}
-
-	function handleEsc(e: KeyboardEvent) {
-		// e.stopPropagation();
-
-		if (e.key === 'Escape') {
-			e.preventDefault();
-			if (!mandatory) {
-				dialog?.close();
-			}
-		}
-	}
-</script>
-
-<dialog
-	style="--timer: {defaultTimer && defaultTimer.time.toString() + 'ms'}; {minWidth &&
-		`--dialog-min-width: ${minWidth};`} {minHeight &&
-		`--dialog-min-height: ${minHeight};`} {height && `--dialog-height: ${height};`} {width &&
-		`--dialog-width: ${width};`}"
-	class:static-height={staticHeight}
-	class:static-width={staticWidth}
-	class:noscroll
-	bind:this={dialog}
-	{onclose}
-	onkeydown={handleEsc}
-	onclick={(e) => {
-		if (e.target === dialog) {
-			if (!mandatory) {
-				dialog.close();
-			}
-		}
-		clearTimer();
-	}}
->
-	<form
-		method="dialog"
-		bind:this={form}
-		onsubmit={(e) => {
-			e.preventDefault();
-			if (isActive) {
-				onsubmit?.(e);
-			}
-		}}
-		class="modal-root"
-	>
-		<div class="modal-header">
-			{#if mandatory}
-				<div class="title-wrapper">
-					<h3 class="modal-heading">{header}</h3>
-				</div>
-			{:else}
-				<div class="title-wrapper">
-					<h3 class="modal-heading padded">{header}</h3>
-					<div class="close-button">
-						<Action
-							size={Size.Large}
-							onclick={() => {
-								dialog?.close();
-							}}
-							icon={{
-								name: 'cross',
-								size: Size.DoubleXLarge,
-							}}
-							onkeydown={handleEsc}
-							colourSet={ColourSet.Primary}
-							label="Close Modal"
-						/>
-					</div>
-				</div>
-			{/if}
-
-			{#if headerExtra}
-				{@render headerExtra()}
-			{/if}
-		</div>
-
-		{#if defaultTimer}
-			<!-- class:paused -->
-			<div class="bar-container">
-				<div
-					class:paused
-					class="bar-timer"
-				></div>
-			</div>
-		{/if}
-
-		<div
-			class="modal-main"
-			class:row
-			class:wrap
-			class:noscroll
-		>
-			{#if explanation}
-				{@render explanation()}
-			{/if}
-			{@render children()}
-		</div>
-
-		{#if footer}
-			{@render footer()}
-		{:else if buttons?.length}
-			<div class="modal-footer">
-				{#each buttons as button (button)}
-					{#if button.callback}
-						<div class="button-barcode-set">
-							{#if button.barcodeValue}
-								{@const icon = DATAMatrix(button.barcodeValue)}
-								<DataMatrixIcon
-									title={button.label}
-									{icon}
-								/>
-							{/if}
-							{#await button.isValid}
-								<button
-									onkeydown={passthrough}
-									disabled
-									class:margin-left={button.margin === 'left'}
-									class:margin-right={button.margin === 'right'}
-									type={button.type ?? 'button'}
-									onclick={button.callback}>{button.label}</button
-								>
-							{:then buttonIsValid}
-								<button
-									class:call-to-action={button.colourSet === ColourSet.CallToAction}
-									class:primary={button.colourSet === ColourSet.Primary}
-									class:secondary-colour={button.colourSet === ColourSet.Secondary}
-									class:warning={button.colourSet === ColourSet.Warning}
-									class:error={button.colourSet === ColourSet.Error}
-									class:info={button.colourSet === ColourSet.Info}
-									onkeydown={passthrough}
-									disabled={buttonIsValid === false}
-									class:margin-left={button.margin === 'left'}
-									class:margin-right={button.margin === 'right'}
-									type={button.type ?? 'button'}
-									onclick={button.callback}>{button.label}</button
-								>
-							{/await}
-						</div>
-					{:else}
-						<div class="button-barcode-set">
-							{#if button.barcodeValue}
-								{@const icon = DATAMatrix(button.barcodeValue)}
-								<DataMatrixIcon
-									title={button.label}
-									{icon}
-								/>
-							{/if}
-							{#await button.isValid}
-								<button
-									onkeydown={passthrough}
-									disabled
-									class:margin-left={button.margin === 'left'}
-									class:margin-right={button.margin === 'right'}
-									bind:this={submitRef}
-									type={button.type ?? 'submit'}>{button.label}await</button
-								>
-							{:then buttonIsValid}
-								<button
-									class:call-to-action={button.colourSet === ColourSet.CallToAction}
-									class:primary={button.colourSet === ColourSet.Primary}
-									class:secondary-colour={button.colourSet === ColourSet.Secondary}
-									class:warning={button.colourSet === ColourSet.Warning}
-									class:error={button.colourSet === ColourSet.Error}
-									class:info={button.colourSet === ColourSet.Info}
-									onkeydown={passthrough}
-									disabled={buttonIsValid === false || !isValid}
-									class:margin-left={button.margin === 'left'}
-									class:margin-right={button.margin === 'right'}
-									bind:this={submitRef}
-									type={button.type ?? 'submit'}>{button.label}</button
-								>
-							{/await}
-						</div>
-					{/if}
-				{/each}
-			</div>
-		{/if}
-	</form>
-</dialog>
-
+<svelte:options runes />
+
+<script
+	module
+	lang="ts"
+>
+	import { DATAMatrix } from '../../Helpers/Datamatrix.js';
+	import { useAsyncFlag } from '../../Helpers/AsyncFlag.svelte.js';
+	import { passthrough } from '../../Helpers/Helpers.svelte.js';
+	import { ColourSet } from '../../scss/colours.js';
+	import { Size } from '../../Types/Internal/Size.js';
+	import { onMount } from 'svelte';
+	import Action from '../Action.svelte';
+	import BaseModal from '../Base/BaseModal.svelte';
+	import DataMatrixIcon from '../DataMatrixIcon.svelte';
+	import type { TouchModalProps } from './TouchModalProps.js';
+</script>
+
+<script lang="ts">
+	let {
+		header,
+		buttons,
+		mandatory = false,
+		staticHeight = false,
+		staticWidth = false,
+		minWidth = '400px',
+		minHeight = '280px',
+		width,
+		height,
+		onShowCallback,
+		defaultTimer,
+		isValid = true,
+		noscroll = false,
+		onsubmit,
+		headerExtra,
+		explanation,
+		children,
+		footer,
+		onclose,
+		row,
+		wrap,
+		submitRef = $bindable(),
+	}: TouchModalProps = $props();
+
+	let open = $state(true);
+	let form: HTMLFormElement | undefined = $state();
+	let timeout: ReturnType<typeof setTimeout> | undefined = undefined;
+	let paused = $state(false);
+	let isActive = $state(false);
+
+	// Pre-compute barcode SVGs once per `buttons` array. Building a DataMatrix
+	// barcode is non-trivial; rebuilding inside the each-block re-runs the
+	// encoder on every render.
+	const barcodeIcons = $derived.by(
+		() => buttons?.map((b) => (b.barcodeValue != null ? DATAMatrix(b.barcodeValue) : null)) ?? []
+	);
+
+	// Resolve each button's `isValid` once at the component level rather than
+	// inside the each-block. `useAsyncFlag` debounces stale resolutions, holds
+	// the previous value until a new Promise settles, and stops the
+	// `{#await}` flicker the previous implementation exhibited.
+	const buttonValidities = useAsyncFlag(
+		() => Promise.all((buttons ?? []).map((b) => Promise.resolve(b.isValid ?? true))),
+		[] as Array<boolean>
+	);
+
+	onMount(() => {
+		queueMicrotask(() => {
+			onShowCallback?.();
+		});
+
+		const activeTimer = setTimeout(() => {
+			isActive = true;
+		}, 200);
+
+		if (defaultTimer) {
+			timeout = setTimeout(() => {
+				if (open) {
+					if (defaultTimer.action === 'submit') {
+						form?.requestSubmit();
+						defaultTimer.callback?.();
+					} else {
+						open = false;
+					}
+				}
+			}, defaultTimer.time);
+		}
+
+		return () => {
+			clearTimeout(activeTimer);
+			clearTimer();
+		};
+	});
+
+	function clearTimer() {
+		if (timeout != undefined) {
+			paused = true;
+			clearTimeout(timeout);
+		}
+	}
+
+	function handleEsc(e: KeyboardEvent) {
+		if (e.key === 'Escape') {
+			e.preventDefault();
+			if (!mandatory) {
+				open = false;
+			}
+		}
+	}
+
+	function requestClose() {
+		open = false;
+	}
+
+	const dialogClassNames = $derived(
+		[
+			staticHeight ? 'static-height' : null,
+			staticWidth ? 'static-width' : null,
+			noscroll ? 'noscroll' : null,
+		]
+			.filter((c): c is string => c !== null)
+			.join(' ')
+	);
+
+	const dialogStyle = $derived(
+		`--timer: ${defaultTimer ? defaultTimer.time.toString() + 'ms' : 'unset'};` +
+			`--dialog-min-width: ${minWidth};` +
+			`--dialog-min-height: ${minHeight};` +
+			(height != null ? `--dialog-height: ${height};` : '') +
+			(width != null ? `--dialog-width: ${width};` : '')
+	);
+</script>
+
+<BaseModal
+	bind:value={open}
+	{onclose}
+	{mandatory}
+	dialogClass={dialogClassNames}
+	{dialogStyle}
+>
+	<!-- svelte-ignore a11y_no_noninteractive_element_interactions -->
+	<!-- svelte-ignore a11y_click_events_have_key_events -->
+	<form
+		method="dialog"
+		bind:this={form}
+		onsubmit={(e) => {
+			e.preventDefault();
+			clearTimer();
+			if (isActive) {
+				onsubmit?.(e);
+			}
+		}}
+		onclick={clearTimer}
+		class="modal-root"
+	>
+		<div class="modal-header">
+			{#if mandatory}
+				<div class="title-wrapper">
+					<h3 class="modal-heading">{header}</h3>
+				</div>
+			{:else}
+				<div class="title-wrapper">
+					<h3 class="modal-heading padded">{header}</h3>
+					<div class="close-button">
+						<Action
+							size={Size.Large}
+							onclick={requestClose}
+							icon={{
+								name: 'cross',
+								size: Size.DoubleXLarge,
+							}}
+							onkeydown={handleEsc}
+							colourSet={ColourSet.Primary}
+							label="Close Modal"
+						/>
+					</div>
+				</div>
+			{/if}
+
+			{#if headerExtra}
+				{@render headerExtra()}
+			{/if}
+		</div>
+
+		{#if defaultTimer}
+			<div class="bar-container">
+				<div
+					class:paused
+					class="bar-timer"
+				></div>
+			</div>
+		{/if}
+
+		<div
+			class="modal-main"
+			class:row
+			class:wrap
+			class:noscroll
+		>
+			{#if explanation}
+				{@render explanation()}
+			{/if}
+			{@render children()}
+		</div>
+
+		{#if footer}
+			{@render footer()}
+		{:else if buttons?.length}
+			<div class="modal-footer">
+				{#each buttons as button, index (button.label)}
+					{@const buttonIsValid = buttonValidities.value[index] ?? true}
+					{#if button.callback}
+						<div class="button-barcode-set">
+							{#if barcodeIcons[index]}
+								<DataMatrixIcon
+									title={button.label}
+									icon={{ kind: 'svg', svg: barcodeIcons[index] }}
+								/>
+							{/if}
+							<button
+								class:call-to-action={button.colourSet === ColourSet.CallToAction}
+								class:primary={button.colourSet === ColourSet.Primary}
+								class:secondary-colour={button.colourSet === ColourSet.Secondary}
+								class:warning={button.colourSet === ColourSet.Warning}
+								class:error={button.colourSet === ColourSet.Error}
+								class:info={button.colourSet === ColourSet.Info}
+								onkeydown={passthrough}
+								disabled={!buttonIsValid}
+								class:margin-left={button.margin === 'left'}
+								class:margin-right={button.margin === 'right'}
+								type={button.type ?? 'button'}
+								onclick={button.callback}>{button.label}</button
+							>
+						</div>
+					{:else}
+						<div class="button-barcode-set">
+							{#if barcodeIcons[index]}
+								<DataMatrixIcon
+									title={button.label}
+									icon={{ kind: 'svg', svg: barcodeIcons[index] }}
+								/>
+							{/if}
+							<button
+								class:call-to-action={button.colourSet === ColourSet.CallToAction}
+								class:primary={button.colourSet === ColourSet.Primary}
+								class:secondary-colour={button.colourSet === ColourSet.Secondary}
+								class:warning={button.colourSet === ColourSet.Warning}
+								class:error={button.colourSet === ColourSet.Error}
+								class:info={button.colourSet === ColourSet.Info}
+								onkeydown={passthrough}
+								disabled={!buttonIsValid || !isValid}
+								class:margin-left={button.margin === 'left'}
+								class:margin-right={button.margin === 'right'}
+								bind:this={submitRef}
+								type={button.type ?? 'submit'}>{button.label}</button
+							>
+						</div>
+					{/if}
+				{/each}
+			</div>
+		{/if}
+	</form>
+</BaseModal>
+
 <style>dialog {
   overflow: clip;
   background-color: #e9ecf1;
@@ -497,4 +503,4 @@ div.bar-container div.bar-timer.paused {
   animation-play-state: paused;
   opacity: 0%;
   transition: opacity 300ms 0s ease-out;
-}</style>
+}</style>

package/dist/Components/Touch/TouchModalProps.d.ts

@@ -1,27 +1,61 @@
 import type { ButtonProp } from '../../Types/Internal/ButtonProp.js';
 import type { Snippet } from 'svelte';
 import type { DefaultTimer } from './DefaultTimer.js';
+/**
+ * Props for `TouchModal`, the touch-friendly variant of `Modal`. Provides
+ * a `<dialog>`-based modal with a header, optional explanation, body,
+ * and either a footer snippet or a `buttons` array. Each button's
+ * `isValid` flag is resolved through `useAsyncFlag`, so promise-based
+ * validation does not flicker the disabled state on re-render.
+ *
+ * Used as the foundation for the Touch-family modal variants
+ * (`NumberModal`, `TextModal`, `TextAreaModal`, `SelectModal`,
+ * `DateModal`).
+ */
 export interface TouchModalProps {
+    /** Header text shown in the modal title bar. */
     header: string;
+    /** Modal body. Rendered inside the scroll container. */
     children: Snippet;
+    /** Fires after the native `<dialog>` element closes. */
     onclose?: () => void;
+    /** Lay the modal body out in row direction. */
     row?: boolean;
+    /** Allow the row-flowed body to wrap. */
     wrap?: boolean;
+    /** Native form submit handler. The default action prevents the
+     * submission and forwards the event. */
     onsubmit?: (e: SubmitEvent) => void;
-    buttons?: Array<ButtonProp>;
+    /** Buttons rendered into the footer. Provide `footer` to override. */
+    buttons?: ReadonlyArray<ButtonProp>;
+    /** If true, the modal cannot be dismissed via Escape or backdrop click. */
     mandatory?: boolean;
+    /** Fix the dialog to its minimum height regardless of content. */
     staticHeight?: boolean;
+    /** Fix the dialog to its minimum width regardless of content. */
     staticWidth?: boolean;
+    /** CSS length string for the dialog's minimum width. */
     minWidth?: string;
+    /** CSS length string for the dialog's minimum height. */
     minHeight?: string;
+    /** CSS length string for the dialog's width. */
     width?: string;
+    /** CSS length string for the dialog's height. */
     height?: string;
+    /** Fires once the dialog has been shown. */
     onShowCallback?: () => void;
+    /** Two-way bindable reference to the submit button DOM element. */
     submitRef?: HTMLButtonElement | undefined;
+    /** Optional countdown timer that auto-submits or auto-closes. */
     defaultTimer?: DefaultTimer;
+    /** Disables the submit button when false. */
     isValid?: boolean;
+    /** Disable the scroll container, letting overflow be visible. */
     noscroll?: boolean;
+    /** Snippet rendered alongside the header (e.g. extra controls). */
     headerExtra?: Snippet;
+    /** Optional explanation snippet rendered above the body. */
     explanation?: Snippet | undefined;
+    /** Footer snippet that replaces the default buttons row. */
     footer?: Snippet;
 }