@lavalogic/scoria 0.37.44 → 0.37.46

package/dist/Components/MultiSelect.svelte

@@ -1,222 +1,222 @@
-<svelte:options runes />
-
-<script
-	lang="ts"
-	generics="V extends object, VP extends ValueProp<V>"
->
-	import { autoPluralise, 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 { SvelteSet } from 'svelte/reactivity';
-	import { onMount } from 'svelte';
-	import Action from './Action.svelte';
-	import Icon from './Icon.svelte';
-	import type { MultiSelectProps } from './MultiSelectProps.js';
-
-	// NOTE selectedValues is mutated by svelecte without asking, so we sometimes have to reverse it without a callback (side effects)
-	const {
-		label,
-		inputId = generateWeakId(),
-		options,
-		labelProp,
-		valueProp,
-		width,
-		valueAsObject = true,
-		height,
-		selectedValues,
-		onchange,
-		collapseSelection = false,
-		name = 'Item',
-		disabled,
-		required,
-		invalid,
-	}: MultiSelectProps<V, VP> = $props();
-
-	const an = $derived(name && vowels.has(name.at(0)?.toLocaleLowerCase() ?? '') ? 'an' : 'a');
-
-	// Pre-computed set of selected primitive keys. Used in the option snippet
-	// to avoid an O(n*m) findIndex sweep per render.
-	const selectedKeys = $derived.by(() => {
-		const s = new SvelteSet<V[VP]>();
-		if (valueAsObject) {
-			for (const v of selectedValues as Array<V>) {
-				s.add(v[valueProp]);
-			}
-		} else {
-			for (const v of selectedValues as Array<V[VP]>) {
-				s.add(v);
-			}
-		}
-		return s;
-	});
-
-	let isExpanded = $state(false);
-
-	onMount(() => {
-		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
-		// in the action snippet further down.
-		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 Svelecte dropdown to `document.body` while open
-		// so it escapes every ancestor `overflow` / `transform` /
-		// `z-index` stacking context. See `Helpers/dropdownPortal.ts`
-		// for the rationale and behaviour (auto-flip upwards on tight
-		// viewports, scroll-aware repositioning, viewport-bounded
-		// max-height).
-		const detachPortal = attachDropdownPortal({
-			getTrigger: () => svelecteRoot,
-			getDropdown: () => dropdownRef,
-		});
-
-		return () => {
-			observer.disconnect();
-			detachPortal();
-		};
-	});
-
-	const isInvalid = $derived((required && !selectedValues.length) || invalid);
-</script>
-
-<div
-	class:invalid={isInvalid}
-	class="select-wrapper"
-	style={`${width ? `--input-width: ${width};` : ''}${height ? `--input-height: ${height};` : ''}`}
->
-	{#if label}
-		<label for={inputId}>
-			<span>{label}</span>
-			<span class="border">{label}</span>
-		</label>
-	{/if}
-
-	<Svelecte
-		multiple
-		{valueAsObject}
-		{disabled}
-		{inputId}
-		valueField={valueProp}
-		labelField={labelProp}
-		{options}
-		searchable
-		value={selectedValues}
-		onChange={(e: Array<V>) => {
-			// svelecte always emits the full option objects; normalise to the
-			// shape the variant promised: primitives for AsPrimitive,
-			// objects for AsObject. This is what the discriminated
-			// `onchange` typing now guarantees to consumers.
-			if (valueAsObject) {
-				void (onchange as (v: Array<V>) => void | Promise<void>)(e);
-			} else {
-				const primitives = e.map((it) => it[valueProp]);
-				void (onchange as (v: Array<V[VP]>) => void | Promise<void>)(primitives);
-			}
-		}}
-		{name}
-		selectOnTab
-		keepSelectionInList
-		searchProps={{ keepSelectionInList: true }}
-		creatable={false}
-		collapseSelection={collapseSelection ? 'always' : null}
-		deselectMode="toggle"
-		highlightFirstItem={false}
-		placeholder="Please Select {name ? `${an} ${name}` : ''}"
-		selection={collapseSelection ? selection : undefined}
-	>
-		{#snippet option(opt)}
-			{@const option = opt as V}
-			<span class="dropdown-item">
-				<div
-					class="toggle-icon"
-					class:yes={selectedKeys.has(option[valueProp])}
-				>
-					<Icon
-						name="tick"
-						size={Size.MediumSmall}
-					/>
-				</div>
-				{option[labelProp]}</span
-			>
-		{/snippet}
-
-		{#snippet collapsedSelection(selectedOptions: Array<object> /*_i18n*/)}
-			<span class="selection"
-				>{#if selectedOptions.length}{selectedOptions.length}
-					{#if name}{autoPluralise(name, selectedOptions.length)}{/if} Selected
-				{:else}Please Select {#if name}
-						{an} {name}{/if}
-				{/if}</span
-			>
-		{/snippet}
-
-		{#snippet append()}
-			<div class="icons">
-				<Action
-					{disabled}
-					size={Size.Small}
-					noTabIndex
-					colourSet={ColourSet.Auxiliary}
-					onclick={(e: MouseEvent) => {
-						if (isExpanded) {
-							e.stopPropagation();
-						}
-
-						if (selectedValues.length) {
-							// Empty array satisfies both Array<V> and Array<V[VP]>.
-							void (onchange as (v: Array<V> | Array<V[VP]>) => void | Promise<void>)([]);
-						} else if (valueAsObject) {
-							void (onchange as (v: Array<V>) => void | Promise<void>)(options.concat());
-						} else {
-							const primitives = options.map((it) => it[valueProp]);
-							void (onchange as (v: Array<V[VP]>) => void | Promise<void>)(primitives);
-						}
-					}}
-					icon={{
-						name: selectedValues.length ? 'close-menu-cross' : 'manage-product-group',
-						colour: Colour['$ui-blue-10'],
-					}}
-				/>
-
-				<Action
-					{disabled}
-					size={Size.Small}
-					noTabIndex
-					colourSet={ColourSet.Auxiliary}
-					icon={{
-						name: isExpanded ? 'chevron-up' : 'chevron-down',
-						colour: Colour['$ui-blue-10'],
-					}}
-				/>
-			</div>
-		{/snippet}
-		{#snippet toggleIcon()}
-			<div class="nothing"></div>
-		{/snippet}
-	</Svelecte>
-
-	{#snippet selection(/*_selectedOptions: Array<unknown>*/)}
-		<!-- collapsed selection rendered above -->
-	{/snippet}
-</div>
-
+<svelte:options runes />
+
+<script
+	lang="ts"
+	generics="V extends object, VP extends ValueProp<V>"
+>
+	import { autoPluralise, 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 { SvelteSet } from 'svelte/reactivity';
+	import { onMount } from 'svelte';
+	import Action from './Action.svelte';
+	import Icon from './Icon.svelte';
+	import type { MultiSelectProps } from './MultiSelectProps.js';
+
+	// NOTE selectedValues is mutated by svelecte without asking, so we sometimes have to reverse it without a callback (side effects)
+	const {
+		label,
+		inputId = generateWeakId(),
+		options,
+		labelProp,
+		valueProp,
+		width,
+		valueAsObject = true,
+		height,
+		selectedValues,
+		onchange,
+		collapseSelection = false,
+		name = 'Item',
+		disabled,
+		required,
+		invalid,
+	}: MultiSelectProps<V, VP> = $props();
+
+	const an = $derived(name && vowels.has(name.at(0)?.toLocaleLowerCase() ?? '') ? 'an' : 'a');
+
+	// Pre-computed set of selected primitive keys. Used in the option snippet
+	// to avoid an O(n*m) findIndex sweep per render.
+	const selectedKeys = $derived.by(() => {
+		const s = new SvelteSet<V[VP]>();
+		if (valueAsObject) {
+			for (const v of selectedValues as Array<V>) {
+				s.add(v[valueProp]);
+			}
+		} else {
+			for (const v of selectedValues as Array<V[VP]>) {
+				s.add(v);
+			}
+		}
+		return s;
+	});
+
+	let isExpanded = $state(false);
+
+	onMount(() => {
+		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
+		// in the action snippet further down.
+		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 Svelecte dropdown to `document.body` while open
+		// so it escapes every ancestor `overflow` / `transform` /
+		// `z-index` stacking context. See `Helpers/dropdownPortal.ts`
+		// for the rationale and behaviour (auto-flip upwards on tight
+		// viewports, scroll-aware repositioning, viewport-bounded
+		// max-height).
+		const detachPortal = attachDropdownPortal({
+			getTrigger: () => svelecteRoot,
+			getDropdown: () => dropdownRef,
+		});
+
+		return () => {
+			observer.disconnect();
+			detachPortal();
+		};
+	});
+
+	const isInvalid = $derived((required && !selectedValues.length) || invalid);
+</script>
+
+<div
+	class:invalid={isInvalid}
+	class="select-wrapper"
+	style={`${width ? `--input-width: ${width};` : ''}${height ? `--input-height: ${height};` : ''}`}
+>
+	{#if label}
+		<label for={inputId}>
+			<span>{label}</span>
+			<span class="border">{label}</span>
+		</label>
+	{/if}
+
+	<Svelecte
+		multiple
+		{valueAsObject}
+		{disabled}
+		{inputId}
+		valueField={valueProp}
+		labelField={labelProp}
+		{options}
+		searchable
+		value={selectedValues}
+		onChange={(e: Array<V>) => {
+			// svelecte always emits the full option objects; normalise to the
+			// shape the variant promised: primitives for AsPrimitive,
+			// objects for AsObject. This is what the discriminated
+			// `onchange` typing now guarantees to consumers.
+			if (valueAsObject) {
+				void (onchange as (v: Array<V>) => void | Promise<void>)(e);
+			} else {
+				const primitives = e.map((it) => it[valueProp]);
+				void (onchange as (v: Array<V[VP]>) => void | Promise<void>)(primitives);
+			}
+		}}
+		{name}
+		selectOnTab
+		keepSelectionInList
+		searchProps={{ keepSelectionInList: true }}
+		creatable={false}
+		collapseSelection={collapseSelection ? 'always' : null}
+		deselectMode="toggle"
+		highlightFirstItem={false}
+		placeholder="Please Select {name ? `${an} ${name}` : ''}"
+		selection={collapseSelection ? selection : undefined}
+	>
+		{#snippet option(opt)}
+			{@const option = opt as V}
+			<span class="dropdown-item">
+				<div
+					class="toggle-icon"
+					class:yes={selectedKeys.has(option[valueProp])}
+				>
+					<Icon
+						name="tick"
+						size={Size.MediumSmall}
+					/>
+				</div>
+				{option[labelProp]}</span
+			>
+		{/snippet}
+
+		{#snippet collapsedSelection(selectedOptions: Array<object> /*_i18n*/)}
+			<span class="selection"
+				>{#if selectedOptions.length}{selectedOptions.length}
+					{#if name}{autoPluralise(name, selectedOptions.length)}{/if} Selected
+				{:else}Please Select {#if name}
+						{an} {name}{/if}
+				{/if}</span
+			>
+		{/snippet}
+
+		{#snippet append()}
+			<div class="icons">
+				<Action
+					{disabled}
+					size={Size.Small}
+					noTabIndex
+					colourSet={ColourSet.Auxiliary}
+					onclick={(e: MouseEvent) => {
+						if (isExpanded) {
+							e.stopPropagation();
+						}
+
+						if (selectedValues.length) {
+							// Empty array satisfies both Array<V> and Array<V[VP]>.
+							void (onchange as (v: Array<V> | Array<V[VP]>) => void | Promise<void>)([]);
+						} else if (valueAsObject) {
+							void (onchange as (v: Array<V>) => void | Promise<void>)(options.concat());
+						} else {
+							const primitives = options.map((it) => it[valueProp]);
+							void (onchange as (v: Array<V[VP]>) => void | Promise<void>)(primitives);
+						}
+					}}
+					icon={{
+						name: selectedValues.length ? 'close-menu-cross' : 'manage-product-group',
+						colour: Colour['$ui-blue-10'],
+					}}
+				/>
+
+				<Action
+					{disabled}
+					size={Size.Small}
+					noTabIndex
+					colourSet={ColourSet.Auxiliary}
+					icon={{
+						name: isExpanded ? 'chevron-up' : 'chevron-down',
+						colour: Colour['$ui-blue-10'],
+					}}
+				/>
+			</div>
+		{/snippet}
+		{#snippet toggleIcon()}
+			<div class="nothing"></div>
+		{/snippet}
+	</Svelecte>
+
+	{#snippet selection(/*_selectedOptions: Array<unknown>*/)}
+		<!-- collapsed selection rendered above -->
+	{/snippet}
+</div>
+
 <style>.select-wrapper {
   min-width: var(--input-min-width, 12rem);
   width: var(--input-width, 100%);
@@ -379,4 +379,4 @@ div.icons {
 }
 :global(.dropdown-item) .toggle-icon.yes {
   opacity: 1;
-}</style>
+}</style>

package/dist/Components/MultiSelectCommonProps.d.ts

@@ -1,9 +1,9 @@
 import type { CssLength, NonNullableKey, ValueProp } from '../Types/Internal/Misc.js';
 /**
- * Keys of `V` whose value is a string. Re-exported for callers that want
- * a tighter constraint than `NonNullableKey<V>`. Currently aliased to
- * `NonNullableKey<V>` to avoid cascading into Table subtree consumers
- * (see workorder MultiSelect P1).
+ * Keys of `V` whose value is a string. Re-exported for callers that want a
+ * tighter constraint than `NonNullableKey<V>`. Currently aliased to
+ * `NonNullableKey<V>` so tightening the brand later does not force every
+ * Table subtree consumer to update at the same time.
  */
 export type StringValuedKey<V> = NonNullableKey<V>;
 export interface MultiSelectCommonProps<V extends object, VP extends ValueProp<V>> {
@@ -25,20 +25,9 @@ export interface MultiSelectCommonProps<V extends object, VP extends ValueProp<V
     label?: string;
     /** DOM id of the underlying svelecte input. */
     inputId?: string;
-    /**
-     * CSS width override. Interpolated into a CSS custom property.
-     *
-     * BREAKING (Phase 7.7): was `string`; now requires the `CssLength`
-     * brand. Use the `cssLength('...')` helper to mark intentional CSS
-     * length strings.
-     */
+    /** CSS width override. Use `cssLength('...')` to construct. */
     width?: CssLength;
-    /**
-     * CSS height override. Interpolated into a CSS custom property.
-     *
-     * BREAKING (Phase 7.7): was `string`; now requires the `CssLength`
-     * brand. Use the `cssLength('...')` helper.
-     */
+    /** CSS height override. Use `cssLength('...')` to construct. */
     height?: CssLength;
     /** When true, render a summary instead of chips. */
     collapseSelection?: boolean;