@nqmcreative/ui 0.2.3 → 0.4.0

package/dist/styles/matte/Button.svelte

@@ -2,6 +2,7 @@
 	import type { Snippet } from 'svelte';
 	import type { HTMLButtonAttributes } from 'svelte/elements';
 	import Spinner from './Spinner.svelte';
+	import { iconMd, iconSm } from './icon.js';
 	import {
 		focusRing,
 		toneBorder,
@@ -17,7 +18,7 @@
 	export type ButtonVariant = 'solid' | 'soft' | 'outline' | 'ghost' | 'link' | 'primary';
 	export type ButtonSize = 'sm' | 'md' | 'lg' | 'xl';
 
-	interface Props extends HTMLButtonAttributes {
+	interface Props extends Omit<HTMLButtonAttributes, 'onclick'> {
 		variant?: ButtonVariant;
 		tone?: Tone;
 		size?: ButtonSize;
@@ -28,7 +29,19 @@
 		loading?: boolean;
 		/** Stretch to the container's full width. */
 		block?: boolean;
-		children: Snippet;
+		/** Leading icon. The spinner takes its place while the button is busy. */
+		icon?: Snippet;
+		/** Trailing icon. */
+		iconEnd?: Snippet;
+		/** Square button with no label — pass an `aria-label`. */
+		iconOnly?: boolean;
+		/**
+		 * Return a promise — a save, a submit, a fetch — and the button spins and
+		 * locks itself until it settles, without any state in the parent. It
+		 * unlocks on a rejection too, so catch failures inside the handler.
+		 */
+		onclick?: (event: MouseEvent) => unknown;
+		children?: Snippet;
 	}
 
 	let {
@@ -38,6 +51,10 @@
 		href,
 		loading = false,
 		block = false,
+		icon,
+		iconEnd,
+		iconOnly = false,
+		onclick,
 		disabled = false,
 		type = 'button',
 		class: className = '',
@@ -55,6 +72,13 @@
 		xl: 'h-12 px-8 text-base'
 	};
 
+	const squares: Record<ButtonSize, string> = {
+		sm: 'size-8',
+		md: 'size-10',
+		lg: 'size-11',
+		xl: 'size-12'
+	};
+
 	const variantClass = $derived.by(() => {
 		switch (variant) {
 			case 'primary':
@@ -72,7 +96,24 @@
 	});
 
 	const isLink = $derived(variant === 'link');
-	const inert = $derived(disabled || loading);
+
+	/** Set by an `onclick` that returned a promise, on top of the `loading` prop. */
+	let pending = $state(false);
+	const busy = $derived(loading || pending);
+	const inert = $derived(disabled || busy);
+
+	const iconClass = $derived(size === 'sm' ? iconSm : iconMd);
+
+	async function handleClick(event: MouseEvent) {
+		const result = onclick?.(event);
+		// Anything else is a plain handler: nothing to wait for, nothing to lock.
+		if (!(result instanceof Promise)) return;
+		pending = true;
+		// The handler owns its own errors — catch them there to show a message.
+		// All the button needs to know is that the work has settled.
+		await result.catch(() => {});
+		pending = false;
+	}
 </script>
 
 <svelte:element
@@ -81,14 +122,24 @@
 	type={href ? undefined : type}
 	disabled={href ? undefined : inert}
 	aria-disabled={href && inert ? 'true' : undefined}
-	aria-busy={loading ? 'true' : undefined}
+	aria-busy={busy ? 'true' : undefined}
 	role={href ? 'button' : undefined}
-	class="{base} {focusRing} {toneRing[tone]} {variantClass} {isLink ? '' : sizes[size]}
+	class="{base} {focusRing} {toneRing[tone]} {variantClass} {isLink
+		? ''
+		: iconOnly
+			? squares[size]
+			: sizes[size]}
 		{block ? 'w-full' : ''} {className}"
 	{...rest}
+	onclick={handleClick}
 >
-	{#if loading}
+	{#if busy}
 		<Spinner size={size === 'sm' ? 'xs' : 'sm'} label="" />
+	{:else if icon}
+		<span class={iconClass} aria-hidden="true">{@render icon()}</span>
+	{/if}
+	{@render children?.()}
+	{#if iconEnd && !iconOnly}
+		<span class={iconClass} aria-hidden="true">{@render iconEnd()}</span>
 	{/if}
-	{@render children()}
 </svelte:element>

package/dist/styles/matte/Button.svelte.d.ts

@@ -3,7 +3,7 @@ import type { HTMLButtonAttributes } from 'svelte/elements';
 import { type Tone } from '../../core/tones.js';
 export type ButtonVariant = 'solid' | 'soft' | 'outline' | 'ghost' | 'link' | 'primary';
 export type ButtonSize = 'sm' | 'md' | 'lg' | 'xl';
-interface Props extends HTMLButtonAttributes {
+interface Props extends Omit<HTMLButtonAttributes, 'onclick'> {
     variant?: ButtonVariant;
     tone?: Tone;
     size?: ButtonSize;
@@ -14,7 +14,19 @@ interface Props extends HTMLButtonAttributes {
     loading?: boolean;
     /** Stretch to the container's full width. */
     block?: boolean;
-    children: Snippet;
+    /** Leading icon. The spinner takes its place while the button is busy. */
+    icon?: Snippet;
+    /** Trailing icon. */
+    iconEnd?: Snippet;
+    /** Square button with no label — pass an `aria-label`. */
+    iconOnly?: boolean;
+    /**
+     * Return a promise — a save, a submit, a fetch — and the button spins and
+     * locks itself until it settles, without any state in the parent. It
+     * unlocks on a rejection too, so catch failures inside the handler.
+     */
+    onclick?: (event: MouseEvent) => unknown;
+    children?: Snippet;
 }
 declare const Button: import("svelte").Component<Props, {}, "">;
 type Button = ReturnType<typeof Button>;

package/dist/styles/matte/Card.svelte

@@ -2,6 +2,7 @@
 	import type { Snippet } from 'svelte';
 	import type { HTMLAttributes } from 'svelte/elements';
 	import { toneBorderLeft, toneHoverBorder, toneSurface, type Tone } from '../../core/tones.js';
+	import { iconLg } from './icon.js';
 
 	export type CardVariant = 'outline' | 'filled' | 'tinted';
 
@@ -15,6 +16,8 @@
 		padded?: boolean;
 		title?: string;
 		eyebrow?: string;
+		/** Leading icon above the title. Ignored when you pass `header`. */
+		icon?: Snippet;
 		header?: Snippet;
 		footer?: Snippet;
 		children: Snippet;
@@ -28,6 +31,7 @@
 		padded = true,
 		title,
 		eyebrow,
+		icon,
 		header,
 		footer,
 		class: className = '',
@@ -49,11 +53,12 @@
 		{className}"
 	{...rest}
 >
-	{#if header || title || eyebrow}
+	{#if header || title || eyebrow || icon}
 		<div class="flex flex-col gap-1 {padded ? 'px-5 pt-5' : ''}">
 			{#if header}
 				{@render header()}
 			{:else}
+				{#if icon}<span class={iconLg}>{@render icon()}</span>{/if}
 				{#if eyebrow}
 					<span class="font-mono text-xs tracking-wide text-text-muted uppercase">{eyebrow}</span>
 				{/if}

package/dist/styles/matte/Card.svelte.d.ts

@@ -12,6 +12,8 @@ interface Props extends HTMLAttributes<HTMLDivElement> {
     padded?: boolean;
     title?: string;
     eyebrow?: string;
+    /** Leading icon above the title. Ignored when you pass `header`. */
+    icon?: Snippet;
     header?: Snippet;
     footer?: Snippet;
     children: Snippet;

package/dist/styles/matte/CheckboxGroup.svelte

@@ -3,10 +3,13 @@
 	import type { HTMLFieldsetAttributes } from 'svelte/elements';
 	import Checkbox from './Checkbox.svelte';
 	import type { Tone } from '../../core/tones.js';
+	import { iconLg } from './icon.js';
 
 	export interface CheckboxOption {
 		value: string;
 		label: string;
+		/** Leading icon, 20px. Drawn in `boxed` mode only. */
+		icon?: Snippet;
 		description?: string;
 		disabled?: boolean;
 	}
@@ -76,6 +79,9 @@
 							{checked ? 'border-text bg-bg-alt' : 'border-hairline hover:border-hairline-strong'}
 							{disabled ? 'pointer-events-none opacity-50' : ''}"
 					>
+						{#if option.icon}
+							<span class={iconLg}>{@render option.icon()}</span>
+						{/if}
 						<Checkbox
 							{checked}
 							{disabled}

package/dist/styles/matte/CheckboxGroup.svelte.d.ts

@@ -4,6 +4,8 @@ import type { Tone } from '../../core/tones.js';
 export interface CheckboxOption {
     value: string;
     label: string;
+    /** Leading icon, 20px. Drawn in `boxed` mode only. */
+    icon?: Snippet;
     description?: string;
     disabled?: boolean;
 }

package/dist/styles/matte/ColorInput.svelte

@@ -0,0 +1,110 @@
+<script lang="ts">
+	import type { HTMLInputAttributes } from 'svelte/elements';
+	import { normaliseHex } from '../../core/color.js';
+	import { useLocale } from '../../core/locale.svelte.js';
+	import type { Tone } from '../../core/tones.js';
+	import Input, { type InputSize } from './Input.svelte';
+
+	interface Props extends Omit<HTMLInputAttributes, 'size' | 'prefix' | 'suffix' | 'type'> {
+		/** Bindable `#rrggbb`. Shorthand and alpha are normalised away on blur. */
+		value?: string;
+		size?: InputSize;
+		tone?: Tone;
+		invalid?: boolean;
+		/** Fixed choices under the field. Empty hides the row. */
+		swatches?: string[];
+		class?: string;
+	}
+
+	let {
+		value = $bindable('#000000'),
+		size = 'md',
+		tone = 'brand',
+		invalid = false,
+		disabled = false,
+		swatches = [],
+		class: className = '',
+		...rest
+	}: Props = $props();
+
+	const t = useLocale();
+
+	// The text can be mid-typing (`#a2`) while the swatch needs a real colour,
+	// so the swatch follows the last value that parsed rather than the field.
+	let text = $state('');
+	let editing = $state(false);
+
+	$effect(() => {
+		if (!editing) text = value;
+	});
+
+	const resolved = $derived(normaliseHex(text) ?? normaliseHex(value) ?? '#000000');
+
+	// Same reason as CurrencyInput: at input time the bound `text` is one
+	// keystroke behind, so the element is the only current source.
+	function onText(event: Event & { currentTarget: HTMLInputElement }) {
+		const hex = normaliseHex(event.currentTarget.value);
+		if (hex) value = hex;
+	}
+
+	function settle() {
+		editing = false;
+		value = normaliseHex(text) ?? value;
+		text = value;
+	}
+
+	function choose(hex: string) {
+		value = normaliseHex(hex) ?? value;
+		text = value;
+	}
+</script>
+
+<div class="flex w-full flex-col gap-2 {className}">
+	<Input
+		bind:value={text}
+		{size}
+		{tone}
+		{invalid}
+		{disabled}
+		spellcheck="false"
+		autocapitalize="none"
+		placeholder="#000000"
+		oninput={onText}
+		onfocus={() => (editing = true)}
+		onblur={settle}
+		class="[&_input]:font-mono [&_input]:uppercase"
+		{...rest}
+	>
+		{#snippet prefix()}
+			<span class="relative grid size-5 place-items-center border border-hairline">
+				<span class="absolute inset-0" style="background-color: {resolved}"></span>
+				<input
+					type="color"
+					value={resolved}
+					{disabled}
+					aria-label={t.current.pickColour}
+					oninput={(event) => choose(event.currentTarget.value)}
+					class="absolute inset-0 cursor-pointer opacity-0 disabled:cursor-not-allowed"
+				/>
+			</span>
+		{/snippet}
+	</Input>
+
+	{#if swatches.length}
+		<div class="flex flex-wrap gap-1.5">
+			{#each swatches as swatch (swatch)}
+				<button
+					type="button"
+					{disabled}
+					onclick={() => choose(swatch)}
+					title={swatch}
+					aria-label={swatch}
+					aria-pressed={resolved === normaliseHex(swatch)}
+					class="size-6 border transition-transform duration-150 hover:-translate-y-0.5 focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-current disabled:pointer-events-none disabled:opacity-50
+						{resolved === normaliseHex(swatch) ? 'border-text' : 'border-hairline'}"
+					style="background-color: {swatch}"
+				></button>
+			{/each}
+		</div>
+	{/if}
+</div>

package/dist/styles/matte/ColorInput.svelte.d.ts

@@ -0,0 +1,16 @@
+import type { HTMLInputAttributes } from 'svelte/elements';
+import type { Tone } from '../../core/tones.js';
+import { type InputSize } from './Input.svelte';
+interface Props extends Omit<HTMLInputAttributes, 'size' | 'prefix' | 'suffix' | 'type'> {
+    /** Bindable `#rrggbb`. Shorthand and alpha are normalised away on blur. */
+    value?: string;
+    size?: InputSize;
+    tone?: Tone;
+    invalid?: boolean;
+    /** Fixed choices under the field. Empty hides the row. */
+    swatches?: string[];
+    class?: string;
+}
+declare const ColorInput: import("svelte").Component<Props, {}, "value">;
+type ColorInput = ReturnType<typeof ColorInput>;
+export default ColorInput;

package/dist/styles/matte/Combobox.svelte

@@ -1,13 +1,17 @@
 <script lang="ts">
+	import type { Snippet } from 'svelte';
 	import { anchored } from '../../core/actions/anchor.js';
 	import { clickOutside, portal } from '../../core/actions/dismissable.js';
 	import { ListCursor, groupItems, matchQuery, revealIndex } from '../../core/list.svelte.js';
 	import { toneFocusWithinBorder, toneSoft, toneText, type Tone } from '../../core/tones.js';
 	import { useLocale } from '../../core/locale.svelte.js';
+	import { iconMd } from './icon.js';
 
 	export interface ComboboxOption {
 		value: string;
 		label: string;
+		/** Leading icon, 16px. */
+		icon?: Snippet;
 		/** Second line under the label. */
 		description?: string;
 		disabled?: boolean;
@@ -234,6 +238,7 @@
 							{index === active ? toneSoft[tone] : 'text-text-secondary'}"
 					>
 						<span class="flex items-center gap-2">
+							{#if option.icon}<span class={iconMd}>{@render option.icon()}</span>{/if}
 							<span class="min-w-0 flex-1 truncate">{option.label}</span>
 							{#if option.value === value}
 								<svg

package/dist/styles/matte/Combobox.svelte.d.ts

@@ -1,7 +1,10 @@
+import type { Snippet } from 'svelte';
 import { type Tone } from '../../core/tones.js';
 export interface ComboboxOption {
     value: string;
     label: string;
+    /** Leading icon, 16px. */
+    icon?: Snippet;
     /** Second line under the label. */
     description?: string;
     disabled?: boolean;

package/dist/styles/matte/CommandPalette.svelte

@@ -1,7 +1,11 @@
 <script module lang="ts">
+	import type { Snippet } from 'svelte';
+
 	export interface CommandItem {
 		id: string;
 		label: string;
+		/** Leading icon, 16px. */
+		icon?: Snippet;
 		/** Second line under the label. */
 		description?: string;
 		/** Items sharing a group are rendered under one heading. */
@@ -22,6 +26,7 @@
 	import { useLocale } from '../../core/locale.svelte.js';
 	import { toneSoft, type Tone } from '../../core/tones.js';
 	import { isTypingTarget } from '../../core/trigger.js';
+	import { iconMd } from './icon.js';
 	import Kbd from './Kbd.svelte';
 
 	interface Props {
@@ -218,6 +223,7 @@
 								{item.disabled ? 'pointer-events-none opacity-40' : ''}
 								{index === active ? toneSoft[tone] : 'text-text-secondary'}"
 						>
+							{#if item.icon}<span class={iconMd}>{@render item.icon()}</span>{/if}
 							<span class="flex min-w-0 flex-1 flex-col gap-0.5">
 								<span class="truncate">{item.label}</span>
 								{#if item.description}

package/dist/styles/matte/CommandPalette.svelte.d.ts

@@ -1,6 +1,9 @@
+import type { Snippet } from 'svelte';
 export interface CommandItem {
     id: string;
     label: string;
+    /** Leading icon, 16px. */
+    icon?: Snippet;
     /** Second line under the label. */
     description?: string;
     /** Items sharing a group are rendered under one heading. */

package/dist/styles/matte/CurrencyInput.svelte

@@ -0,0 +1,108 @@
+<script lang="ts">
+	import type { HTMLInputAttributes } from 'svelte/elements';
+	import { formatGrouped, parseGrouped } from '../../core/number.js';
+	import type { Tone } from '../../core/tones.js';
+	import Input, { type InputSize } from './Input.svelte';
+
+	interface Props extends Omit<
+		HTMLInputAttributes,
+		'size' | 'prefix' | 'suffix' | 'value' | 'min' | 'max'
+	> {
+		/** Bindable amount. `null` is an empty field, which is not the same as 0. */
+		value?: number | null;
+		min?: number;
+		max?: number;
+		/** Thousands separator. */
+		group?: string;
+		/** Decimal separator. */
+		decimal?: string;
+		/** Decimal places the amount settles to when the field loses focus. */
+		precision?: number;
+		/** Leading mark — `Rp`, `$`, `€`. */
+		currency?: string;
+		/** Trailing mark instead, for the locales that write it that way. */
+		unit?: string;
+		size?: InputSize;
+		tone?: Tone;
+		invalid?: boolean;
+		class?: string;
+	}
+
+	let {
+		value = $bindable(null),
+		min,
+		max,
+		group = ',',
+		decimal = '.',
+		precision = 2,
+		currency,
+		unit,
+		size = 'md',
+		tone = 'brand',
+		invalid = false,
+		disabled = false,
+		class: className = '',
+		...rest
+	}: Props = $props();
+
+	const options = $derived({ group, decimal, precision });
+
+	/**
+	 * What the field shows. Two states on purpose: grouped and padded while the
+	 * caret is elsewhere, and exactly what was typed while it is not — grouping
+	 * a number as it is typed moves the caret out from under the fingers.
+	 */
+	let text = $state('');
+	let editing = $state(false);
+
+	$effect(() => {
+		if (editing) return;
+		text = value === null || value === undefined ? '' : formatGrouped(value, options);
+	});
+
+	// Read off the element, not off `text`: the binding that feeds `text` has
+	// not flushed yet when this fires, so it still holds the previous keystroke.
+	function onInput(event: Event & { currentTarget: HTMLInputElement }) {
+		const parsed = parseGrouped(event.currentTarget.value, options);
+		value = parsed === null ? null : clamp(parsed);
+	}
+
+	function clamp(amount: number) {
+		if (min !== undefined && amount < min) return min;
+		if (max !== undefined && amount > max) return max;
+		return amount;
+	}
+
+	function settle() {
+		editing = false;
+		const parsed = parseGrouped(text, options);
+		value = parsed === null ? null : clamp(parsed);
+		text = value === null ? '' : formatGrouped(value, options);
+	}
+</script>
+
+<Input
+	bind:value={text}
+	{size}
+	{tone}
+	{invalid}
+	{disabled}
+	inputmode="decimal"
+	oninput={onInput}
+	onfocus={() => (editing = true)}
+	onblur={settle}
+	class={className}
+	{...rest}
+>
+	{#snippet prefix()}
+		{#if currency}
+			<span class="font-mono text-xs tracking-wide">{currency}</span>
+		{/if}
+	{/snippet}
+
+	{#snippet suffix()}
+		{#if unit}
+			<span class="font-mono text-xs tracking-wide">{unit}</span>
+		{/if}
+	{/snippet}
+</Input>

package/dist/styles/matte/CurrencyInput.svelte.d.ts

@@ -0,0 +1,26 @@
+import type { HTMLInputAttributes } from 'svelte/elements';
+import type { Tone } from '../../core/tones.js';
+import { type InputSize } from './Input.svelte';
+interface Props extends Omit<HTMLInputAttributes, 'size' | 'prefix' | 'suffix' | 'value' | 'min' | 'max'> {
+    /** Bindable amount. `null` is an empty field, which is not the same as 0. */
+    value?: number | null;
+    min?: number;
+    max?: number;
+    /** Thousands separator. */
+    group?: string;
+    /** Decimal separator. */
+    decimal?: string;
+    /** Decimal places the amount settles to when the field loses focus. */
+    precision?: number;
+    /** Leading mark — `Rp`, `$`, `€`. */
+    currency?: string;
+    /** Trailing mark instead, for the locales that write it that way. */
+    unit?: string;
+    size?: InputSize;
+    tone?: Tone;
+    invalid?: boolean;
+    class?: string;
+}
+declare const CurrencyInput: import("svelte").Component<Props, {}, "value">;
+type CurrencyInput = ReturnType<typeof CurrencyInput>;
+export default CurrencyInput;

package/dist/styles/matte/Drawer.svelte

@@ -1,5 +1,6 @@
 <script lang="ts">
 	import type { Snippet } from 'svelte';
+	import { iconLg } from './icon.js';
 	import type { HTMLDialogAttributes } from 'svelte/elements';
 	import { useLocale } from '../../core/locale.svelte.js';
 	import { isBackdropClick, syncDialog } from '../../core/dialog.svelte.js';
@@ -15,6 +16,8 @@
 		size?: DrawerSize;
 		title?: string;
 		description?: string;
+		/** Leading icon beside the title. */
+		icon?: Snippet;
 		dismissible?: boolean;
 		footer?: Snippet;
 		onclose?: () => void;
@@ -27,6 +30,7 @@
 		size = 'md',
 		title,
 		description,
+		icon,
 		dismissible = true,
 		footer,
 		onclose,
@@ -92,6 +96,7 @@
 	<div class="flex h-full flex-col">
 		{#if title || dismissible}
 			<div class="flex items-start gap-4 border-b border-hairline px-5 py-4">
+				{#if icon}<span class={iconLg}>{@render icon()}</span>{/if}
 				<div class="flex min-w-0 flex-1 flex-col gap-1">
 					{#if title}
 						<h2 class="font-heading text-lg font-medium tracking-tight">{title}</h2>

package/dist/styles/matte/Drawer.svelte.d.ts

@@ -10,6 +10,8 @@ interface Props extends HTMLDialogAttributes {
     size?: DrawerSize;
     title?: string;
     description?: string;
+    /** Leading icon beside the title. */
+    icon?: Snippet;
     dismissible?: boolean;
     footer?: Snippet;
     onclose?: () => void;