@lavalogic/scoria 0.35.0 → 0.37.0

package/dist/Components/TextArea.svelte

@@ -1,110 +1,129 @@
-<svelte:options runes />
-
-<script lang="ts">
-	import { InputVariant } from '../Types/Internal/InputVariant.js';
-	import { Size } from '../Types/Internal/Size.js';
-	import Icon from './Icon.svelte';
-	import type { TextAreaProps } from './TextAreaProps.js';
-
-	let {
-		value = $bindable(''),
-		labelTop,
-		labelRight,
-		placeholder,
-		maxWidth = false,
-		required = false,
-		variant = InputVariant.Default,
-		selectNone = false,
-		noresize = false,
-		uppercase = false,
-		disabled,
-		invalid = false,
-		showErrorColours = false,
-		optional = false,
-		leftIcon,
-		rightIcon,
-		onLeftIconClick,
-		onRightIconClick,
-		rows = 4,
-
-		textAreaRef = $bindable(),
-		onblur,
-		onfocus
-	}: TextAreaProps = $props();
-
-	let isInvalid = $derived(showErrorColours && ((required && value.trim() === '') || invalid));
-</script>
-
-<label class:for-modal={variant === InputVariant.Modal} class:max-width={maxWidth}>
-	<!-- HACK removed label for modals for now because I couldn't think of a decent style that doesn't interfere with scrolling -->
-	{#if labelTop && variant !== InputVariant.Modal}
-		<!-- <span class="top-label" class:invalid={isInvalid}>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span> -->
-		<span
-			class="top-label"
-			class:for-default={variant === InputVariant.Default}
-			class:invalid={isInvalid}
-			>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
-		>
-		{#if variant === InputVariant.Default}
-			<span class="border" class:invalid={isInvalid}
-				>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
-			>
-		{/if}
-	{/if}
-	<!-- style="--background-colour: {leftIcon?.backgroundColour ?? rightIcon?.backgroundColour};" -->
-	<div class="icon-container" class:for-modal={variant == InputVariant.Modal}>
-		{#if leftIcon}
-			<Icon
-				name={leftIcon.name}
-				size={leftIcon.size ?? Size.Medium}
-				colour={leftIcon.colour}
-				float
-				left="0.75rem"
-				top="50%"
-				anchorX="0"
-				anchorY="-50%"
-				clickable={!!onLeftIconClick}
-				onclick={onLeftIconClick}
-			/>
-		{/if}
-		<textarea
-			class:noresize
-			class:uppercase
-			class:invalid={isInvalid}
-			class:select-none={selectNone}
-			class:left-pad={leftIcon != undefined}
-			class:right-pad={rightIcon != undefined}
-			class:for-modal={variant == InputVariant.Modal}
-			class:max-width={maxWidth}
-			bind:value
-			{onblur}
-			{onfocus}
-			{rows}
-			bind:this={textAreaRef}
-			{placeholder}
-			{required}
-			{disabled}
-		></textarea>
-		{#if rightIcon}
-			<Icon
-				name={rightIcon.name}
-				size={rightIcon.size ?? Size.Medium}
-				colour={rightIcon.colour}
-				float
-				right={variant == InputVariant.Modal ? '1rem' : '0.5rem'}
-				top="50%"
-				anchorX="0"
-				anchorY="-50%"
-				clickable={!!onRightIconClick}
-				onclick={onRightIconClick}
-			/>
-		{/if}
-		{#if labelRight}
-			<span class="right-label" class:for-modal={variant == InputVariant.Modal}>{labelRight}</span>
-		{/if}
-	</div>
-</label>
-
+<svelte:options runes />
+
+<script lang="ts">
+	import { cssLength, passthrough } from '../Helpers/Helpers.svelte.js';
+	import { InputVariant } from '../Types/Internal/InputVariant.js';
+	import { Size } from '../Types/Internal/Size.js';
+	import Icon from './Icon.svelte';
+	import type { TextAreaProps } from './TextAreaProps.js';
+
+	let {
+		value = $bindable(''),
+		labelTop,
+		labelRight,
+		placeholder,
+		maxWidth = false,
+		required = false,
+		variant = InputVariant.Default,
+		selectNone = false,
+		noresize = false,
+		uppercase = false,
+		disabled,
+		invalid = false,
+		showErrorColours = true,
+		optional = false,
+		leftIcon,
+		rightIcon,
+		onLeftIconClick,
+		onRightIconClick,
+		rows = 4,
+
+		textAreaRef = $bindable(),
+		autocomplete,
+		spellcheck,
+		onblur,
+		onfocus,
+		onkeydown = passthrough,
+		oninput,
+	}: TextAreaProps = $props();
+
+	const isInvalid = $derived(showErrorColours && ((required && value.trim() === '') || invalid));
+</script>
+
+<label
+	class:for-modal={variant === InputVariant.Modal}
+	class:max-width={maxWidth}
+>
+	{#if labelTop && variant !== InputVariant.Modal}
+		<span
+			class="top-label"
+			class:for-default={variant === InputVariant.Default}
+			class:invalid={isInvalid}
+			>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
+		>
+		{#if variant === InputVariant.Default}
+			<span
+				aria-hidden="true"
+				class="border"
+				class:invalid={isInvalid}
+				>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
+			>
+		{/if}
+	{/if}
+	<div
+		class="icon-container"
+		class:for-modal={variant == InputVariant.Modal}
+	>
+		{#if leftIcon}
+			<Icon
+				name={leftIcon.name}
+				size={leftIcon.size ?? Size.Medium}
+				colour={leftIcon.colour}
+				float
+				left={cssLength('0.75rem')}
+				top={cssLength('50%')}
+				anchorX={cssLength('0')}
+				anchorY={cssLength('-50%')}
+				clickable={!!onLeftIconClick}
+				onclick={onLeftIconClick}
+			/>
+		{/if}
+		<textarea
+			class:noresize
+			class:uppercase
+			class:invalid={isInvalid}
+			class:select-none={selectNone}
+			class:left-pad={leftIcon != undefined}
+			class:right-pad={rightIcon != undefined}
+			class:for-modal={variant == InputVariant.Modal}
+			class:max-width={maxWidth}
+			autocomplete={autocomplete ?? 'off'}
+			spellcheck={spellcheck ?? true}
+			aria-invalid={isInvalid || undefined}
+			bind:value
+			{onblur}
+			{onfocus}
+			{onkeydown}
+			{oninput}
+			{rows}
+			bind:this={textAreaRef}
+			{placeholder}
+			{required}
+			{disabled}
+		></textarea>
+		{#if rightIcon}
+			<Icon
+				name={rightIcon.name}
+				size={rightIcon.size ?? Size.Medium}
+				colour={rightIcon.colour}
+				float
+				right={cssLength(variant == InputVariant.Modal ? '1rem' : '0.5rem')}
+				top={cssLength('50%')}
+				anchorX={cssLength('0')}
+				anchorY={cssLength('-50%')}
+				clickable={!!onRightIconClick}
+				onclick={onRightIconClick}
+			/>
+		{/if}
+		{#if labelRight}
+			<span
+				class="right-label"
+				class:for-modal={variant == InputVariant.Modal}>{labelRight}</span
+			>
+		{/if}
+	</div>
+</label>
+
 <style>textarea {
   box-sizing: border-box;
   height: 100%;
@@ -318,4 +337,4 @@ span.border.invalid {
 .textarea-error-wrapper.for-modal {
   position: relative;
   height: 100%;
-}</style>
+}</style>

package/dist/Components/TextAreaProps.d.ts

@@ -1,26 +1,63 @@
 import type { InputVariant } from '../Types/Internal/InputVariant.js';
+import type { FormEventHandler } from 'svelte/elements';
 import type { PartialIconProps } from './PartialIconProps.js';
+/**
+ * Props for the {@link TextArea} component.
+ *
+ * Mirrors {@link TextInputProps} where applicable. `value` is `string`
+ * (non-nullable) by design.
+ */
 export interface TextAreaProps {
+    /** Current text value. Bindable. */
     value: string;
+    /** Blur handler forwarded to the `<textarea>`. */
     onblur?: (e: FocusEvent) => void;
+    /** Focus handler forwarded to the `<textarea>`. */
     onfocus?: (e: FocusEvent) => void;
+    /** Keydown handler. Defaults to `passthrough`. */
+    onkeydown?: (e: KeyboardEvent) => void;
+    /** Input event forwarded to the `<textarea>`. */
+    oninput?: FormEventHandler<HTMLTextAreaElement>;
+    /** Label rendered above the textarea. */
     labelTop?: string | undefined;
+    /** Label rendered inside the textarea on the right. */
     labelRight?: string;
+    /** Native `placeholder` attribute. */
     placeholder?: string | undefined;
+    /** Native `required` attribute. */
     required?: boolean;
+    /** Render variant. See {@link InputVariant}. */
     variant?: InputVariant;
+    /** Disable native text selection on the textarea. */
     selectNone?: boolean;
+    /** Render the "- optional" suffix next to `labelTop`. */
     optional?: boolean;
+    /** Force the rendered value uppercase via CSS. */
     uppercase?: boolean;
+    /** Native `disabled` attribute. */
     disabled?: boolean;
+    /** Force the invalid visual state. */
     invalid?: boolean;
+    /** Constrain the textarea to its `max-width`. Defaults to false. */
     maxWidth?: boolean;
+    /** When true, render invalid visuals for unmet `required`/`invalid`. Defaults to true. */
     showErrorColours?: boolean;
+    /** Icon rendered on the left of the textarea. */
     leftIcon?: PartialIconProps;
+    /** Icon rendered on the right of the textarea. */
     rightIcon?: PartialIconProps;
+    /** Click handler for the left icon. */
     onLeftIconClick?: () => void;
+    /** Click handler for the right icon. */
     onRightIconClick?: () => void;
+    /** Number of visual rows. Must be a positive integer. Defaults to 4. */
     rows?: number;
+    /** Bindable reference to the underlying `<textarea>`. */
     textAreaRef?: HTMLTextAreaElement | undefined;
+    /** Suppress the resize handle. */
     noresize?: boolean;
+    /** Native `autocomplete` value. Defaults to `'off'`. */
+    autocomplete?: import('svelte/elements').HTMLTextareaAttributes['autocomplete'];
+    /** Native `spellcheck` attribute. Defaults to `true`. */
+    spellcheck?: boolean;
 }

package/dist/Components/TextInput.svelte

@@ -1,149 +1,168 @@
-<svelte:options runes />
-
-<script lang="ts">
-	import { isValidEmailAddress } from '../Helpers/Helpers.svelte.js';
-	import { Colour, ColourSet } from '../scss/colours.js';
-	import { InputVariant } from '../Types/Internal/InputVariant.js';
-	import { Size } from '../Types/Internal/Size.js';
-	import Action from './Action.svelte';
-	import Icon from './Icon.svelte';
-	import type { TextInputProps } from './TextInputProps.js';
-	let {
-		id,
-		value = $bindable(''),
-		labelTop,
-		optional,
-		labelRight,
-		placeholder,
-		required = false,
-		variant = InputVariant.Default,
-		selectNone = false,
-		uppercase = false,
-		disabled = false,
-		invalid = false,
-		showErrorColours = true,
-		rightIconDisabled = false,
-		// leftIconDisabled = false,
-		leftIcon,
-		rightIcon,
-		type,
-		onLeftIconClick,
-		onRightIconClick,
-		inputRef = $bindable(),
-		'data-type': dataType,
-		onblur,
-		onfocus,
-		onkeydown,
-		oninput,
-	}: TextInputProps = $props();
-
-	let isInvalid = $derived(
-		showErrorColours &&
-			!disabled &&
-			((required && (!value?.trim() || (type == 'email' && !isValidEmailAddress(value)))) ||
-				invalid)
-	);
-</script>
-
-<div
-	class="error-wrapper"
-	class:for-modal={variant == InputVariant.Modal}
-	class:for-table={variant == InputVariant.Table}
->
-	<label
-		class:for-modal={variant == InputVariant.Modal}
-		class:for-table={variant == InputVariant.Table}
-	>
-		{#if labelTop}
-			<span
-				class="top-label"
-				class:for-default={variant === InputVariant.Default}
-				class:invalid={isInvalid}
-				>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
-			>
-			{#if variant === InputVariant.Default}
-				<span
-					class="border"
-					class:invalid={isInvalid}
-					>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
-				>
-			{/if}
-		{/if}
-		<div
-			class="icon-container"
-			class:for-modal={variant == InputVariant.Modal}
-		>
-			{#if leftIcon}
-				<!-- TODO make this identical to right icon -->
-				<Icon
-					name={leftIcon.name}
-					size={leftIcon.size ?? Size.Medium}
-					colour={leftIcon.colour}
-					float
-					left="0.75rem"
-					top="50%"
-					anchorX="0"
-					anchorY="-50%"
-					clickable={!!onLeftIconClick}
-					onclick={() => onLeftIconClick?.()}
-				/>
-			{/if}
-			<input
-				{id}
-				class:for-default={variant === InputVariant.Default}
-				class:uppercase
-				class:invalid={isInvalid}
-				class:select-none={selectNone}
-				class:left-pad={leftIcon != undefined}
-				class:right-pad={rightIcon != undefined}
-				class:for-modal={variant == InputVariant.Modal}
-				data-type={dataType}
-				type={type ?? 'text'}
-				bind:value
-				{onblur}
-				{onfocus}
-				{onkeydown}
-				{oninput}
-				bind:this={inputRef}
-				{placeholder}
-				{required}
-				{disabled}
-			/>
-			{#if rightIcon}
-				<div class="right-icon">
-					{#if onRightIconClick}
-						<Action
-							noTabIndex
-							colourSet={ColourSet.Auxiliary}
-							disabled={rightIconDisabled}
-							icon={rightIcon}
-							size={Size.Medium}
-							onclick={onRightIconClick}
-						/>
-					{:else}
-						<Icon
-							name={rightIcon.name}
-							size={rightIcon.size ?? Size.Medium}
-							colour={rightIcon.colour ?? Colour['$font-disabled']}
-							float
-							right={variant == InputVariant.Modal ? '1rem' : '0.5rem'}
-							top="50%"
-							anchorX="0"
-							anchorY="-50%"
-						/>
-					{/if}
-				</div>
-			{/if}
-			{#if labelRight}
-				<span
-					class="right-label"
-					class:for-modal={variant == InputVariant.Modal}>{labelRight}</span
-				>
-			{/if}
-		</div>
-	</label>
-</div>
-
+<svelte:options runes />
+
+<script lang="ts">
+	import { cssLength, isValidEmailAddress, passthrough } from '../Helpers/Helpers.svelte.js';
+	import { Colour, ColourSet } from '../scss/colours.js';
+	import { InputVariant } from '../Types/Internal/InputVariant.js';
+	import { Size } from '../Types/Internal/Size.js';
+	import Action from './Action.svelte';
+	import Icon from './Icon.svelte';
+	import type { TextInputProps } from './TextInputProps.js';
+	let {
+		id,
+		value = $bindable(''),
+		labelTop,
+		optional,
+		labelRight,
+		placeholder,
+		required = false,
+		variant = InputVariant.Default,
+		selectNone = false,
+		uppercase = false,
+		disabled = false,
+		invalid = false,
+		showErrorColours = true,
+		rightIconDisabled = false,
+		leftIcon,
+		rightIcon,
+		type,
+		onLeftIconClick,
+		onRightIconClick,
+		inputRef = $bindable(),
+		'data-type': dataType,
+		autocomplete,
+		spellcheck,
+		onblur,
+		onfocus,
+		onkeydown = passthrough,
+		oninput,
+	}: TextInputProps = $props();
+
+	const isInvalid = $derived(
+		showErrorColours &&
+			!disabled &&
+			((required &&
+				(!value?.trim() ||
+					(type == 'email' &&
+						value.length >= 3 &&
+						value.includes('@') &&
+						!isValidEmailAddress(value)))) ||
+				invalid)
+	);
+</script>
+
+<div
+	class="error-wrapper"
+	class:for-modal={variant == InputVariant.Modal}
+	class:for-table={variant == InputVariant.Table}
+>
+	<label
+		class:for-modal={variant == InputVariant.Modal}
+		class:for-table={variant == InputVariant.Table}
+	>
+		{#if labelTop}
+			<span
+				class="top-label"
+				class:for-default={variant === InputVariant.Default}
+				class:invalid={isInvalid}
+				>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
+			>
+			{#if variant === InputVariant.Default}
+				<span
+					aria-hidden="true"
+					class="border"
+					class:invalid={isInvalid}
+					>{labelTop}{#if optional}<i>&nbsp;- optional</i>{/if}</span
+				>
+			{/if}
+		{/if}
+		<div
+			class="icon-container"
+			class:for-modal={variant == InputVariant.Modal}
+		>
+			{#if leftIcon}
+				{#if onLeftIconClick}
+					<div class="left-icon">
+						<Action
+							noTabIndex
+							colourSet={ColourSet.Auxiliary}
+							icon={leftIcon}
+							size={Size.Medium}
+							onclick={onLeftIconClick}
+						/>
+					</div>
+				{:else}
+					<Icon
+						name={leftIcon.name}
+						size={leftIcon.size ?? Size.Medium}
+						colour={leftIcon.colour}
+						float
+						left={cssLength('0.75rem')}
+						top={cssLength('50%')}
+						anchorX={cssLength('0')}
+						anchorY={cssLength('-50%')}
+					/>
+				{/if}
+			{/if}
+			<input
+				{id}
+				class:for-default={variant === InputVariant.Default}
+				class:uppercase
+				class:invalid={isInvalid}
+				class:select-none={selectNone}
+				class:left-pad={leftIcon != undefined}
+				class:right-pad={rightIcon != undefined}
+				class:for-modal={variant == InputVariant.Modal}
+				data-type={dataType}
+				type={type ?? 'text'}
+				autocomplete={autocomplete ?? (type === 'email' ? 'email' : 'off')}
+				spellcheck={spellcheck ?? false}
+				aria-invalid={isInvalid || undefined}
+				bind:value
+				{onblur}
+				{onfocus}
+				{onkeydown}
+				{oninput}
+				bind:this={inputRef}
+				{placeholder}
+				{required}
+				{disabled}
+			/>
+			{#if rightIcon}
+				<div class="right-icon">
+					{#if onRightIconClick}
+						<Action
+							noTabIndex
+							colourSet={ColourSet.Auxiliary}
+							disabled={rightIconDisabled}
+							icon={rightIcon}
+							size={Size.Medium}
+							onclick={onRightIconClick}
+						/>
+					{:else}
+						<Icon
+							name={rightIcon.name}
+							size={rightIcon.size ?? Size.Medium}
+							colour={rightIcon.colour ?? Colour['$font-disabled']}
+							float
+							right={cssLength(variant == InputVariant.Modal ? '1rem' : '0.5rem')}
+							top={cssLength('50%')}
+							anchorX={cssLength('0')}
+							anchorY={cssLength('-50%')}
+						/>
+					{/if}
+				</div>
+			{/if}
+			{#if labelRight}
+				<span
+					class="right-label"
+					class:for-modal={variant == InputVariant.Modal}>{labelRight}</span
+				>
+			{/if}
+		</div>
+	</label>
+</div>
+
 <style>input {
   box-sizing: border-box;
   height: 100%;
@@ -377,4 +396,4 @@ label.for-table input {
 
 td {
   --input-border: none;
-}</style>
+}</style>