@torpor/ui 0.2.0 → 0.2.1

package/src/Accordion/AccordionTypes.ts

@@ -25,6 +25,8 @@ export interface ItemState {
 	index: number;
 	value: string;
 	expanded: boolean;
+	headerId: string;
+	contentId: string;
 	disabled: boolean;
 	parentDisabled: boolean;
 	dataState: "open" | "closed";

package/src/Breadcrumb/Breadcrumb.torp

@@ -1,4 +1,13 @@
 
+interface BreadcrumbProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the popover to screen readers  */
+	ariaLabel?: string | undefined,
+}
+
 /**
  *
  * A list of links to the parent pages of the current page in hierarchical order.
@@ -17,10 +26,10 @@
  * ```
  *
  * You can separate BreadcrumbItems using BreadcrumbSeparators or by using CSS.
- *
- * @prop {string | undefined} ariaLabel -- An ARIA label for describing the popover to screen readers 
  */
-export default function Breadcrumb($props: any) {
+export default function Breadcrumb($props: BreadcrumbProps) {
+	$props ??= $watch({});
+
 	@render {
 		<nav
 			{$props.id}

package/src/Breadcrumb/BreadcrumbItem.torp

@@ -1,11 +1,20 @@
 
+interface BreadcrumbItemProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this is the current page */
+	current?: boolean,
+}
+
 /**
  * An item in a breadcrumb, containing a link to one of the parent pages of the
  * current page (or the current page).
- *
- * @prop {boolean | undefined} current -- Whether this is the current page
  */
-export default function BreadcrumbItem($props: any) {
+export default function BreadcrumbItem($props: BreadcrumbItemProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div
 			{$props.id}

package/src/Breadcrumb/BreadcrumbSeparator.torp

@@ -1,9 +1,18 @@
 
+interface BreadcrumbSeparatorProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * A separator between links in a Breadcrumb component. It is hidden from
  * screen readers.
  */
-export default function BreadcrumbSeparator($props: any) {
+export default function BreadcrumbSeparator($props: BreadcrumbSeparatorProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div
 			{$props.id}

package/src/Calendar/Calendar.torp

@@ -7,7 +7,15 @@ import ChevronRight from "../icons/ChevronRight.torp";
 
 // TODO: Split this out into Calendar, CalendarHeader, CalendarPreviousTrigger, CalendarGrid etc
 
-export default function Calendar() {
+interface CalendarProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+export default function Calendar($props: CalendarProps) {
+	$props ??= $watch({});
 	$props.startOfWeek ??= 1;
 	$props.selectable ??= false;
 	$props.value ??= new Date();

package/src/Calendar/CalendarDay.torp

@@ -1,7 +1,15 @@
 import { areDatesEqual } from "../utils/dateUtils";
 import { type CalendarContext, type CalendarEvent, CalendarContextName } from "./CalendarTypes";
 
-export default function CalendarDay() {
+interface CalendarDayProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+export default function CalendarDay($props: CalendarDayProps) {
+	$props ??= $watch({});
 	$props.date ??= new Date();
 	$props.selectable ??= false;
 	$props.muted ??= false;

package/src/Dialog/Dialog.torp

@@ -4,6 +4,17 @@ import { trapFocus, type TrapFocusOptions } from "../mount/trapFocus";
 import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes";
 import { DialogContextName, type DialogContext, type DialogState } from "./DialogTypes";
 
+interface DialogProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the popover to screen readers  */
+	ariaLabel?: string,
+	/** Whether the dialog should alert the user via the screen reader */
+	alert?: boolean,
+}
+
 /**
  * Content for a window displayed in a Popover.
  * 
@@ -21,10 +32,9 @@ import { DialogContextName, type DialogContext, type DialogState } from "./Dialo
  * </Dialog>
  * ```
  * 
- * @prop {string | undefined} ariaLabel -- An ARIA label for describing the popover to screen readers 
- * @prop {boolean} alert -- Whether the dialog should alert the user via the screen reader
  */
-export default function Dialog($props: any) {
+export default function Dialog($props: DialogProps) {
+	$props ??= $watch({});
 	$props.id ??= getId();
 	$props.dialog ??= false;
 

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;
 

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

package/src/Dialog/DialogFooter.torp

@@ -1,7 +1,17 @@
+
+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
 			{$props.id}

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;
 

package/src/Disclosure/Disclosure.torp

@@ -1,4 +1,17 @@
-import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
+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.
@@ -15,12 +28,9 @@ import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes
  *     <DisclosureContent />
  * </Disclosure>
  * ```
- *
- * @prop {boolean} [expanded] -- Whether the Disclosure is expanded and its content visible
- * @prop {boolean} [disabled] -- If set to true, the user cannot interact with this Disclosure
- * @prop {(boolean) => void} [ontoggle] -- Raised when this item is opened or closed
  */
-export default function Disclosure($props: any) {
+export default function Disclosure($props: DisclosureProps) {
+	$props ??= $watch({});
 	$props.expanded ??= false;
 	$props.disabled ??= false;
 
@@ -61,7 +71,7 @@ export default function Disclosure($props: any) {
 			{$props.id}
 			class={`torp-disclosure-item ${$props.class ?? ""}`.trim()}
 			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			<slot />
 		</div>

package/src/Disclosure/DisclosureContent.torp

@@ -1,20 +1,27 @@
 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.
- *
- * @prop {string} [id] -- An ID for the DisclosureContent's div container
- * @prop {boolean} [ariaRegion] -- Whether this content should act as a region. Set this when the content contains heading elements or a nested Disclosure
  */
-export default function DisclosureContent($props: any) {
+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[DisclosureContextName].state
+	let $state = context.state
 
 	// Set the content ID so that it can be used with aria-controls in DisclosureTrigger
 	$state.contentId = $props.id;
@@ -26,7 +33,7 @@ export default function DisclosureContent($props: any) {
 			role={$props.ariaRegion ? "region" : undefined}
 			aria-labelledby={$state.headerId}
 			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			@if ($state.expanded) {
 				<slot />

package/src/Disclosure/DisclosureHeader.torp

@@ -1,5 +1,14 @@
 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.
  *
@@ -10,15 +19,15 @@ import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes
  *    <DisclosureTrigger />
  * </DisclosureHeader>
  * ```
- *
- * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
  */
-export default function DisclosureHeader($props: any) {
+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[DisclosureContextName].state
+	let $state = context.state
 
 	@render {
 		@// TODO: $props.as
@@ -26,7 +35,7 @@ export default function DisclosureHeader($props: any) {
 			{$props.id}
 			class={`torp-disclosure-header ${$props.class ?? ""}`.trim()}
 			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			<slot />
 		</h4>

package/src/Disclosure/DisclosureTrigger.torp

@@ -1,10 +1,18 @@
 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() {
+export default function DisclosureTrigger($props: DisclosureTriggerProps) {
+	$props ??= $watch({});
 	$props.id ||= getId();
 
 	// Get stuff out of the DisclosureContext
@@ -12,7 +20,7 @@ export default function DisclosureTrigger() {
 	if (!context) {
 		throw new Error("DisclosureTrigger must be contained within a Disclosure");
 	}
-	let $state = $context[DisclosureContextName].state;
+	let $state = context.state;
 
 	// Set the header ID so that it can be used with aria-labelledby in DisclosureContent
 	$state.headerId = $props.id;

package/src/Drawer/Drawer.torp

@@ -1,5 +1,15 @@
 
-export default function Drawer($props: any) {
+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";
 

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;
+}