@torpor/ui 0.1.7 → 0.2.1

package/src/Dialog/DialogBody.torp

@@ -1,13 +1,21 @@
 import getId from "../utils/getId";
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogBodyProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the body content will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: boolean,
+}
+
 /**
  * The body information for a Dialog. Content in the body will be announced by
  * screen readers when the Dialog is opened, unless ariaAnnounce is false.
- * 
- * @prop {boolean} ariaAnnounce -- Whether the body content will be announced by screen readers when the Dialog is opened
  */
-export default function DialogBody($props: any) {
+export default function DialogBody($props: DialogBodyProps) {
+	$props ??= $watch({});
 	$props.id ??= getId();
 	$props.ariaAnnounce ??= true;
 
@@ -25,10 +33,10 @@ export default function DialogBody($props: any) {
 
 	@render {
 		<div
-			id={$props.id} 
+			{$props.id} 
 			class={`torp-dialog-body ${$props.class ?? ""}`.trim()}
 		>
-			<:slot />
+			<slot />
 		</div>
 	}
 }

package/src/Dialog/DialogButton.torp

@@ -1,13 +1,25 @@
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogButtonProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value that should be returned when this button is pressed and the Dialog was invoked by calling showContextual, showPrompt or showPopover */
+	value?: any,
+	/** "confirm" if the button should respond to the Enter key or "cancel" if the button should respond to the Escape key */
+	type?: "confirm" | "cancel",
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a DialogFooter and signals a response by a user.
  * 
- * @prop {any | undefined} value -- The value that should be returned when this button is pressed and the Dialog was invoked by calling showContextual, showPrompt or showPopover
- * @prop {"confirm" | "cancel" | undefined} type -- "confirm" if the button should respond to the Enter key or "cancel" if the button should respond to the Escape key
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function DialogButton($props: any) {
+export default function DialogButton($props: DialogButtonProps) {
+	$props ??= $watch({});
+
 	let button: HTMLButtonElement;
 
 	// Get stuff out of the DialogContext
@@ -36,13 +48,13 @@ export default function DialogButton($props: any) {
 	@render {
 		<button
 			type="button"
-			id={$props.id}
+			{$props.id}
 			class={`torp-dialog-button ${$props.class ?? ""}`.trim()}
 			disabled={$props.disabled}
 			onclick={handleClick}
 			&ref={button}
 		>
-			<:slot />
+			<slot />
 		</button>
 	}
 }

package/src/Dialog/DialogFooter.torp

@@ -1,13 +1,23 @@
+
+interface DialogFooterProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The footer for a Dialog, which may contain one or more DialogButtons.
  */
-export default function DialogFooter($props: any) {
+export default function DialogFooter($props: DialogFooterProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div
-			id={$props.id}
+			{$props.id}
 			class={`torp-dialog-footer ${$props.class ?? ""}`.trim()}
 		>
-			<:slot />
+			<slot />
 		</div>
 	}
 }

package/src/Dialog/DialogHeader.torp

@@ -1,13 +1,22 @@
 import getId from "../utils/getId";
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogHeaderProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the header will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: boolean,
+}
+
 /**
  * The header for a Dialog. Content in the header will be announced by screen
  * readers when the Dialog is opened, unless ariaAnnounce is false.
  * 
- * @prop {boolean} ariaAnnounce -- Whether the header will be announced by screen readers when the Dialog is opened
  */
-export default function DialogHeader($props: any) {
+export default function DialogHeader($props: DialogHeaderProps) {
+	$props ??= $watch({});
 	$props.id ??= getId();
 	$props.ariaAnnounce ??= true;
 
@@ -25,10 +34,10 @@ export default function DialogHeader($props: any) {
 
 	@render {
 		<div
-			id={$props.id}
+			{$props.id}
 			class={`torp-dialog-footer ${$props.class ?? ""}`.trim()}
 		>
-			<:slot />
+			<slot />
 		</div>
 	}
 }

package/src/Disclosure/Disclosure.torp

@@ -0,0 +1,79 @@
+import { DisclosureContextName, type DisclosureContext, type DisclosureState } from "./DisclosureTypes";
+
+interface DisclosureProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the Disclosure is expanded and its content visible */
+	expanded?: boolean,
+	/** If set to true, the user cannot interact with this Disclosure */
+	disabled?: boolean,
+	/** Raised when this item is opened or closed */
+	ontoggle?: (open: boolean) => void,
+}
+
+/**
+ * An interactive header that enables users to reveal or hide an associated section of content.
+ *
+ * See [the WAI ARIA guidelines for Disclosures](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/).
+ *
+ * The structure of a Disclosure is:
+ *
+ * ```
+ * <Disclosure>
+ *     <DisclosureHeader>
+ *         <DisclosureTrigger />
+ *     </DisclosureHeader>
+ *     <DisclosureContent />
+ * </Disclosure>
+ * ```
+ */
+export default function Disclosure($props: DisclosureProps) {
+	$props ??= $watch({});
+	$props.expanded ??= false;
+	$props.disabled ??= false;
+
+	let $state: DisclosureState = $watch({
+		expanded: $props.expanded && $props.expanded !== "false",
+		disabled: $props.disabled,
+		get dataState() {
+			return this.expanded ? "open" : "closed";
+		},
+	});
+
+	// Update $state with $props
+	$run(() => {
+		$state.expanded = $props.expanded && $props.expanded !== "false";
+		$state.disabled = $props.disabled;
+	});
+
+	// Put stuff into a DisclosureContext
+	const itemContext: DisclosureContext = {
+		state: $state,
+	};
+	$context[DisclosureContextName] = itemContext;
+
+	// Dispatch the toggle event when the value of expanded changes
+	let firstToggle = true;
+	$run(() => {
+		const ev = $props.ontoggle;
+		const expanded = $state.expanded;
+		if (firstToggle) {
+			firstToggle = false;
+		} else if (ev) {
+			ev(expanded);
+		}
+	});
+
+	@render {
+		<div
+			{$props.id}
+			class={`torp-disclosure-item ${$props.class ?? ""}`.trim()}
+			data-state={$state.dataState}
+			data-disabled={$state.disabled ? "true" : undefined}
+		>
+			<slot />
+		</div>
+	}
+}

package/src/Disclosure/DisclosureContent.torp

@@ -0,0 +1,43 @@
+import getId from "../utils/getId";
+import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
+
+interface DisclosureContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this content should act as a region. Set this when the content contains heading elements or a nested Disclosure */
+	ariaRegion?: boolean,
+}
+
+/**
+ * Content for a Disclosure, which can be revealed or hidden by an associated DisclosureTrigger.
+ */
+export default function DisclosureContent($props: DisclosureContentProps) {
+	$props ??= $watch({});
+	$props.id ||= getId();
+
+	const context = $context[DisclosureContextName] as DisclosureContext;
+	if (!context) {
+		throw new Error("DisclosureContent must be contained within a Disclosure");
+	}
+	let $state = context.state
+
+	// Set the content ID so that it can be used with aria-controls in DisclosureTrigger
+	$state.contentId = $props.id;
+
+	@render {
+		<div
+			{$props.id}
+			class={`torp-disclosure-content ${$props.class ?? ""}`.trim()}
+			role={$props.ariaRegion ? "region" : undefined}
+			aria-labelledby={$state.headerId}
+			data-state={$state.dataState}
+			data-disabled={$state.disabled ? "true" : undefined}
+		>
+			@if ($state.expanded) {
+				<slot />
+			}
+		</div>
+	}
+}

package/src/Disclosure/DisclosureHeader.torp

@@ -0,0 +1,43 @@
+import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
+
+interface DisclosureHeaderProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The type of HTML header to use */
+	as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6",
+}
+
+/**
+ * The header for a Disclosure, which contains the DisclosureTrigger.
+ *
+ * The structure of a DisclosureHeader is:
+ * 
+ * ```
+ * <DisclosureHeader>
+ *    <DisclosureTrigger />
+ * </DisclosureHeader>
+ * ```
+ */
+export default function DisclosureHeader($props: DisclosureHeaderProps) {
+	$props ??= $watch({});
+
+	const context = $context[DisclosureContextName] as DisclosureContext;
+	if (!context) {
+		throw new Error("DisclosureHeader must be contained within a Disclosure");
+	}
+	let $state = context.state
+
+	@render {
+		@// TODO: $props.as
+		<h4
+			{$props.id}
+			class={`torp-disclosure-header ${$props.class ?? ""}`.trim()}
+			data-state={$state.dataState}
+			data-disabled={$state.disabled ? "true" : undefined}
+		>
+			<slot />
+		</h4>
+	}
+}

package/src/Disclosure/DisclosureTrigger.torp

@@ -0,0 +1,44 @@
+import getId from "../utils/getId";
+import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
+
+interface DisclosureTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * A header button for a Disclosure, which can be used to reveal or hide an associated DisclosureContent.
+ */
+export default function DisclosureTrigger($props: DisclosureTriggerProps) {
+	$props ??= $watch({});
+	$props.id ||= getId();
+
+	// Get stuff out of the DisclosureContext
+	const context = $context[DisclosureContextName] as DisclosureContext;
+	if (!context) {
+		throw new Error("DisclosureTrigger must be contained within a Disclosure");
+	}
+	let $state = context.state;
+
+	// Set the header ID so that it can be used with aria-labelledby in DisclosureContent
+	$state.headerId = $props.id;
+
+	@render {
+		<button
+			type="button"
+			{$props.id}
+			class={`torp-disclosure-trigger ${$props.class ?? ""}`.trim()}
+			disabled={$state.disabled || $state.parentDisabled}
+			aria-expanded={$state.expanded.toString()}
+			aria-disabled={$state.disabled}
+			aria-controls={$state.contentId}
+			data-state={$state.dataState}
+			data-disabled={$state.disabled}
+			onclick={() => $state.expanded = !$state.expanded}
+		>
+			<slot />
+		</button>
+	}
+}

package/src/Disclosure/DisclosureTypes.ts

@@ -0,0 +1,14 @@
+export const DisclosureContextName = "Disclosure";
+
+export interface DisclosureContext {
+	/** The reactive state for a Disclosure */
+	state: DisclosureState;
+}
+
+export interface DisclosureState {
+	headerId: string;
+	contentId: string;
+	expanded: boolean;
+	disabled: boolean;
+	dataState: "open" | "closed";
+}

package/src/Disclosure/index.ts

@@ -0,0 +1,6 @@
+import Disclosure from "./Disclosure.torp";
+import DisclosureContent from "./DisclosureContent.torp";
+import DisclosureHeader from "./DisclosureHeader.torp";
+import DisclosureTrigger from "./DisclosureTrigger.torp";
+
+export { Disclosure, DisclosureHeader, DisclosureTrigger, DisclosureContent };

package/{dist/Offscreen/Offscreen.torp → src/Drawer/Drawer.torp}

@@ -1,6 +1,16 @@
 
-export default function Offscreen($props: any) {
-	$props.visible ||= true;
+interface DrawerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	visible?: boolean,
+	position?: "left" | "right",
+}
+
+export default function Drawer($props: DrawerProps) {
+	$props ??= $watch({});
+	$props.visible ??= true;
 	$props.position ||= "left";
 
 	let offscreen: HTMLElement | undefined;
@@ -66,25 +76,16 @@ export default function Offscreen($props: any) {
 		}
 	}
 
-	function close() {
-		$props.visible = false;
-		if ($props.onclose) {
-			$props.onclose()
-		}
-	}
-
 	@render {
 		@if ($props.visible) {
-			<div onclick={close} >
-				<div
-					id={$props.id}
-					class={`torp-offscreen ${$props.class ?? ""}`.trim()}
-					style="position: fixed;"
-					:transition={transitionArgs()}
-					&ref={offscreen}
-				>
-					<:slot />
-				</div>
+			<div
+				{$props.id}
+				class={`torp-offscreen ${$props.class ?? ""}`.trim()}
+				style="position: fixed;"
+				transition={transitionArgs()}
+				&ref={offscreen}
+			>
+				<slot />
 			</div>
 		}
 	}

package/src/Drawer/index.ts

@@ -0,0 +1,3 @@
+import Drawer from "./Drawer.torp";
+
+export { Drawer };

package/src/Form/Field.torp

@@ -0,0 +1,93 @@
+import {
+	FormContextName,
+	FieldContextName,
+	type ValidationIssue,
+	type FormContext,
+	type FieldContext,
+} from "./FormTypes";
+import { StandardSchemaV1 } from "./StandardSchemaV1"
+
+interface FieldProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The name of the data that this field contains */
+	name: string,
+	/** The data value that this field is bound to */
+	value?: any,
+	/** The schema validator to use for this form */
+	schema?: StandardSchemaV1,
+};
+
+/**
+ * A field in a form which automatically links up a Label and/or an input
+ * component and/or a Message.
+ */
+export default function Field($props: FieldProps) {
+	$props ??= $watch({ name: "" });
+
+	let $state = $watch({
+		inputId: "-1",
+		value: $props.value,
+		issues: [] as ValidationIssue[],
+		get valid() {
+			return this.issues.find((i) => i.path === $props.name) === undefined;
+		},
+		get message() {
+			return this.issues.filter((i) => i.path === $props.name).map((i) => i.message).join("\n");
+		},
+	});
+
+	// Binding
+	$run(() => {
+		$props.value = $state.value;
+	});
+
+	// Get stuff out of the FormContext, if applicable
+	const formContext = $context[FormContextName] as FormContext;
+	if (formContext) {
+		$run(() => {
+			$state.issues = formContext.state.issues;
+		});
+	}
+
+	// Set the context to pass down to Labels, Inputs and Messages
+	let context: FieldContext = {
+		name: $props.name,
+		state: $state,
+		validate: handleValidate
+	};
+	$context[FieldContextName] = context;
+
+	async function validate() {
+		if ($props.schema) {
+			const validator = $props.schema["~standard"];
+			let result = validator.validate($props.value);
+			if (result instanceof Promise) {
+				result = await result;
+			}
+			let issues: ValidationIssue[] = [];
+			if (result.issues) {
+				for (let issue of result.issues) {
+					issues.push({ path: $props.name, message: issue.message });
+				}
+			}
+			$state.issues = $state.issues.filter((e) => e.path !== $props.name).concat(issues);
+		}
+	}
+
+	async function handleValidate() {
+		await validate();
+	}
+
+	@render {
+		<div
+			{$props.id}
+			class={`torp-field ${$props.class ?? ""}`.trim()}
+			data-valid={$state.valid ? "valid" : "invalid"}
+		>
+			<slot />
+		</div>
+	}
+}

package/src/Form/Form.torp

@@ -0,0 +1,131 @@
+import { FormContextName, type ValidationIssue, type FormContext } from "./FormTypes";
+import { StandardSchemaV1 } from "./StandardSchemaV1"
+
+interface FormProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The data to display in the form */
+	data?: any,
+	/** Where to post the form's data **/
+	action?: string,
+	/** The schema validator to use for this form */
+	schema?: StandardSchemaV1,
+	onsubmit?: (e: SubmitEvent) => boolean | void | Promise<boolean | void>,
+};
+
+/**
+ * A form for submitting values.
+ */
+export default function Form($props: FormProps) {
+	$props ??= $watch({});
+
+	let $state = $watch({
+		data: $props.data ?? {},
+		issues: [] as ValidationIssue[],
+		get valid() {
+			return this.issues.length === 0;
+		}
+	});
+
+	let submitted = false;
+
+	// TODO: Load context from build with a submit method that submits to a form action
+
+	// Set the context to pass down to Fields
+	let context: FormContext = {
+		schema: $props.schema,
+		state: $state,
+		validate: handleValidate
+	};
+	
+	$context[FormContextName] = context;
+
+	async function validate() {
+		if ($props.schema) {
+			const validator = $props.schema["~standard"];
+			let result = validator.validate($props.data);
+			if (result instanceof Promise) {
+				result = await result;
+			}
+			let issues: ValidationIssue[] = [];
+			if (result.issues) {
+				for (let issue of result.issues) {
+					if (issue.path) {
+						// TODO: arrays with `[0]`
+						issues.push({ path: issue.path.join("."), message: issue.message });
+					}
+				}
+			}
+			$state.issues = issues;
+		}
+	}
+
+	async function handleSubmit(e: SubmitEvent) {
+		// Validate, and proceed with submission if there are no errors
+		await validate();
+		let proceed = $state.valid;
+
+		// Changing inputs from now on will cause revalidation
+		submitted = true;
+
+		// If validation failed, don't continue
+		if (!proceed) {
+			e.preventDefault();
+			return false;
+		}
+
+		// Dispatch the submit event for the user to handle
+		if ($props.onsubmit) {
+			let userSubmit = $props.onsubmit(e);
+			if (userSubmit instanceof Promise) {
+				userSubmit = await userSubmit;
+			}
+			proceed = userSubmit !== false && !e.defaultPrevented;
+		}
+		
+		// If the user handled the submit, don't continue
+		if (!proceed) {
+			e.preventDefault();
+			return false;
+		}
+
+		// If there's a @torpor/build context, call its submit event
+		let buildContext = $context["TorporBuildContext"];
+		if (buildContext?.onformsubmit) {
+			let buildSubmit = buildContext.onformsubmit(e);
+			if (buildSubmit instanceof Promise) {
+				buildSubmit = await buildSubmit;
+			}
+			proceed = buildSubmit !== false && !e.defaultPrevented;
+		}
+
+		// If @torpor/build handled the submit, don't continue
+		if (!proceed) {
+			e.preventDefault();
+			return false;
+		}
+
+		// Otherwise just let normal form submission go ahead...
+	}
+
+	async function handleValidate() {
+		if (submitted) {
+			await validate();
+		}
+	}
+
+	@render {
+		<form
+			{$props.id}
+			class={`torp-form ${$props.class ?? ""}`.trim()}
+			method="POST"
+			onsubmit={handleSubmit}
+			@// Set novalidate only if JS is enabled (to override HTML validation)
+			onmount={(e) => e.novalidate = true }
+		>
+			<slot />
+		</form>
+	}
+}

package/src/Form/FormTypes.ts

@@ -0,0 +1,30 @@
+import { type StandardSchemaV1 } from "./StandardSchemaV1";
+
+export const FormContextName: unique symbol = Symbol("Form");
+export const FieldContextName: unique symbol = Symbol("Field");
+
+export interface ValidationIssue {
+	path: string;
+	message: string;
+}
+
+export interface FormContext {
+	schema?: StandardSchemaV1;
+	state: {
+		issues: ValidationIssue[];
+	};
+	validate: () => void;
+}
+
+export interface FieldContext {
+	name: string;
+	schema?: StandardSchemaV1;
+	state: {
+		inputId: string;
+		value?: any;
+		issues: ValidationIssue[];
+		valid: boolean;
+		message: string;
+	};
+	validate: () => void;
+}