@torpor/ui 0.2.1 → 0.3.1

package/dist/Drawer/DrawerOverlay.torp

@@ -0,0 +1,38 @@
+import { disableScroll } from "../mount/disableScroll";
+import { DrawerContextName, type DrawerContext } from "./DrawerTypes";
+
+interface DrawerOverlayProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The background overlay for a Drawer component.
+ * Adding an overlay automatically sets the component's `modal` value to true.
+ */
+export default function DrawerOverlay($props: DrawerOverlayProps | undefined) {
+	// Get stuff out of the DrawerContext
+	const context = $context[DrawerContextName] as DrawerContext;
+	if (!context) {
+		throw new Error("DrawerOverlay must be contained within a Drawer");
+	}
+	let $state = context.state;
+
+	// Any drawer with an overlay is modal
+	$state.modal = true;
+
+	@render {
+		@if ($state.visible) {
+			<div
+				{$props?.id}
+				class={`torp-drawer-overlay ${$props?.class ?? ""}`.trim()}
+				tabindex="-1"
+				onmount={(el) => disableScroll(el)}
+			>
+				<slot />
+			</div>
+		}
+	}
+}

package/dist/Drawer/DrawerTrigger.torp

@@ -0,0 +1,35 @@
+import { DrawerContextName, type DrawerContext } from "./DrawerTypes";
+
+interface DrawerTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The button that causes a Drawer to appear or disappear.
+ */
+export default function DrawerTrigger($props: DrawerTriggerProps | undefined) {
+	// Get stuff out of the DrawerContext
+	const context = $context[DrawerContextName] as DrawerContext;
+	if (!context) {
+		throw new Error("DrawerTrigger must be contained within a Drawer");
+	}
+	let $state = context.state;
+
+	function handleClick() {
+		$state.visible = !$state.visible;
+	}
+
+	@render {
+		<button
+			type="button"
+			{$props?.id}
+			class={`torp-drawer-trigger ${$props?.class ?? ""}`.trim()}
+			onclick={handleClick}
+		>
+			<slot />
+		</button>
+	}
+}

package/dist/Drawer/DrawerTypes.ts

@@ -0,0 +1,24 @@
+export const DrawerContextName = "Drawer";
+
+/** The shared context for drawer components (Contextual, Prompt and Drawer) */
+export interface DrawerContext {
+	handleButton: (type: "confirm" | "cancel" | undefined, value?: any) => void;
+	// HACK: We need to be able to let children (i.e. Dialogs) override the click outside functionality
+	// There may be a more elegant way to accomplish this too
+	handleClickOutside?: (e: MouseEvent) => void;
+	state: DrawerState;
+	// HACK: focusFirstElement is necessary because if we focus the first element e.g. in a Dialog's
+	// onMount, it will scroll the page to the focused element and mess up our careful positioning
+	// We need to be able to manually set the order to
+	// 1. set visible (so we have an element with content)
+	// 2. set position (so the element is in the right place)
+	// 3. set focus (for accessibility)
+	// There may be a more elegant way to accomplish this!
+	focusFirstElement?: () => void;
+}
+
+export interface DrawerState {
+	visible: boolean;
+	modal: boolean;
+	position: "left" | "right" | "top" | "bottom";
+}

package/dist/Drawer/index.d.ts

@@ -6,16 +6,103 @@ interface DrawerProps {
 	id?: string;
 	/** Class name(s) for the root element */
 	class?: string,
+	/** Whether the drawer is modal. If true, an overlay should be supplied to obscure outside content, and only the drawer content will be visible to screen readers  */
+	modal?: boolean,
+	/** Whether the drawer is visible  */
 	visible?: boolean,
-	position?: "left" | "right",
+	/** Which side of the window to show the drawer from */
+	position?: "left" | "right" | "top" | "bottom",
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the drawer is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the drawer has opened */
+	onopen?: () => void,
+	/** Raised when the drawer has closed */
+	onclose?: (result: any) => void,
 }
 
+/**
+ * A drawer that can be used to show rich content or obtain information from a user.
+ *
+ * See [the WAI ARIA guidelines for Dialogs](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/).
+ *
+ * The structure of a Drawer is:
+ *
+ * ```
+ * <Drawer>
+ * 	<DrawerTrigger /> (optional)
+ * 	<DrawerContent />
+ * </Drawer>
+ * ```
+ */
 declare function Drawer(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: DrawerProps,
+	$props: DrawerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
-export { Drawer };
+
+
+interface DrawerContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The content that is displayed for a Drawer when it is open.
+ */
+declare function DrawerContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: DrawerContentProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface DrawerOverlayProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The background overlay for a Drawer component.
+ * Adding an overlay automatically sets the component's `modal` value to true.
+ */
+declare function DrawerOverlay(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: DrawerOverlayProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface DrawerTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The button that causes a Drawer to appear or disappear.
+ */
+declare function DrawerTrigger(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: DrawerTriggerProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { Drawer, DrawerContent, DrawerOverlay, DrawerTrigger };

package/dist/Drawer/index.js

@@ -1,6 +1,18 @@
 // src/Drawer/Drawer.torp
 import Drawer_default from "./Drawer.torp";
+
+// src/Drawer/DrawerContent.torp
+import DrawerContent_default from "./DrawerContent.torp";
+
+// src/Drawer/DrawerOverlay.torp
+import DrawerOverlay_default from "./DrawerOverlay.torp";
+
+// src/Drawer/DrawerTrigger.torp
+import DrawerTrigger_default from "./DrawerTrigger.torp";
 export {
-  Drawer_default as Drawer
+  Drawer_default as Drawer,
+  DrawerContent_default as DrawerContent,
+  DrawerOverlay_default as DrawerOverlay,
+  DrawerTrigger_default as DrawerTrigger
 };
 //# sourceMappingURL=index.js.map

package/dist/Form/CheckBox.torp

@@ -0,0 +1,91 @@
+import getId from "../utils/getId";
+import { FormContextName, FieldContextName, type FormContext, type FieldContext } from "./FormTypes";
+
+interface CheckBoxProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The name of the checkbox's form data field */
+	name?: string,
+	/** Whether the checkbox is checked */
+	checked?: boolean,
+	/** An ARIA label for describing the checkbox to screen readers when there is no associated label element */
+	ariaLabel?: string,
+	/** Raised on change */
+	onchange?: (e: Event) => void,
+	/** Raised on input */
+	oninput?: (e: Event) => void,
+};
+
+/**
+ * A checkbox input in a form.
+ */
+export default function CheckBox($props: CheckBoxProps | undefined) {
+	let defaultId = getId();
+
+	let name = $props?.name
+
+	let blurred = false;
+
+	// Get stuff out of the FormContext and FieldContext
+	const formContext = $context[FormContextName] as FormContext;
+	const fieldContext = $context[FieldContextName] as FieldContext;
+	if (fieldContext) {
+		name ??= fieldContext.name;
+	}
+
+	// Use the FieldContext's state, or create a new one
+	let $state = fieldContext?.state ?? $watch({
+		inputId: $props?.id ?? defaultId,
+		value: $props?.checked,
+		errors: {} as Record<string, string>,
+		valid: false,
+		message: "",
+	});
+
+	// Binding
+	$run(() => {
+		if ($props !== undefined) {
+			$props.checked = $state.value === true;
+		}
+	});
+
+	// Set the input ID now that we know it and it will get linked with the associated label
+	$state.inputId = $props?.id ?? defaultId;
+
+	function handleInput(e: Event) {
+		if (formContext) {
+			formContext.validate();
+		}
+		if (fieldContext && blurred) {
+			fieldContext.validate();
+		}
+		if ($props?.oninput) {
+			$props.oninput(e);
+		}
+	}
+
+	function handleBlur() {
+		if (fieldContext) {
+			fieldContext.validate();
+		}
+		blurred = true;
+	}
+
+	@render {
+		<input
+			id={$props?.id ?? defaultId}
+			class={`torp-check-box
+			 ${$props?.class ?? ""}`.trim()}
+			type="checkbox"
+			{name}
+			&checked={$state.checked}
+			aria-label={$props?.ariaLabel}
+			data-valid={$state.valid ? "valid" : "invalid"}
+			onchange={$props?.onchange}
+			oninput={handleInput}
+			onblur={handleBlur}
+		/>
+	}
+}

package/dist/Form/Field.torp

@@ -25,8 +25,6 @@ interface FieldProps {
  * component and/or a Message.
  */
 export default function Field($props: FieldProps) {
-	$props ??= $watch({ name: "" });
-
 	let $state = $watch({
 		inputId: "-1",
 		value: $props.value,
@@ -83,8 +81,8 @@ export default function Field($props: FieldProps) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-field ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-field ${$props?.class ?? ""}`.trim()}
 			data-valid={$state.valid ? "valid" : "invalid"}
 		>
 			<slot />

package/dist/Form/File.torp

@@ -0,0 +1,106 @@
+import getId from "../utils/getId";
+import { FormContextName, FieldContextName, type FormContext, type FieldContext } from "./FormTypes";
+
+interface FileProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The name of the input's form data field */
+	name?: string,
+	/** The type of files that this input accepts e.g. `image/*` */
+	accepts?: string,
+	/** The data value that this field is bound to */
+	value?: any,
+	/** Text to display when the input value is empty */
+	placeholder?: string,
+	/** Whether the input should be readonly */
+	readonly?: boolean,
+	/** The maximum number of characters allowed for the input value */
+	maxlength?: number,
+	/** An ARIA label for describing the input to screen readers when there is no associated label element */
+	ariaLabel?: string,
+	/** Raised on change */
+	onchange?: (e: Event) => void,
+	/** Raised on input */
+	oninput?: (e: Event) => void,
+};
+
+/**
+ * A file input in a form.
+ */
+export default function Input($props: FileProps | undefined) {
+	let defaultId = getId();
+
+	let name = $props?.name
+
+	let blurred = false;
+
+	// Get stuff out of the FormContext and FieldContext
+	const formContext = $context[FormContextName] as FormContext;
+	const fieldContext = $context[FieldContextName] as FieldContext;
+	if (fieldContext) {
+		name ??= fieldContext.name;
+	}
+
+	// This will change the form's enctype to `multipart/form-data`
+	if (formContext) {
+		formContext.state.hasFile = true;
+	}
+
+	// Use the FieldContext's state, or create a new one
+	let $state = fieldContext?.state ?? $watch({
+		inputId: $props?.id ?? defaultId,
+		value: $props?.value,
+		errors: {} as Record<string, string>,
+		valid: false,
+		message: "",
+	});
+
+	// Binding
+	$run(() => {
+		if ($props !== undefined) {
+			$props.value = $state.value;
+		}
+	});
+
+	// Set the input ID now that we know it and it will get linked with the associated label
+	$state.inputId = $props?.id ?? defaultId;
+
+	function handleInput(e: Event & { currentTarget: EventTarget & HTMLInputElement }) {
+		if (formContext) {
+			formContext.validate();
+		}
+		if (fieldContext && blurred) {
+			fieldContext.validate();
+		}
+		if ($props?.oninput) {
+			$props.oninput(e);
+		}
+	}
+
+	function handleBlur() {
+		if (fieldContext) {
+			fieldContext.validate();
+		}
+		blurred = true;
+	}
+
+	@render {
+		<input
+			id={$props?.id ?? defaultId}
+			class={`torp-file ${$props?.class ?? ""}`.trim()}
+			type="file"
+			{name}
+			&value={$state.value}
+			{$props?.placeholder}
+			{$props?.readonly}
+			{$props?.maxlength}
+			aria-label={$props?.ariaLabel}
+			data-valid={$state.valid ? "valid" : "invalid"}
+			onchange={$props?.onchange}
+			oninput={handleInput}
+			onblur={handleBlur}
+		/>
+	}
+}

package/dist/Form/Form.torp

@@ -10,6 +10,13 @@ interface FormProps {
 	data?: any,
 	/** Where to post the form's data **/
 	action?: string,
+	/** The action to use when submitting the form, which defaults to POST */
+	method?: string,
+	/**
+	 * The form's encoding type e.g. `multipart/form-data` where there are file
+	 * inputs. This will be automatically set unless overridden
+	 */
+	enctype?: string,
 	/** The schema validator to use for this form */
 	schema?: StandardSchemaV1,
 	onsubmit?: (e: SubmitEvent) => boolean | void | Promise<boolean | void>,
@@ -18,11 +25,10 @@ interface FormProps {
 /**
  * A form for submitting values.
  */
-export default function Form($props: FormProps) {
-	$props ??= $watch({});
-
+export default function Form($props: FormProps | undefined) {
 	let $state = $watch({
-		data: $props.data ?? {},
+		data: $props?.data ?? {},
+		hasFile: false,
 		issues: [] as ValidationIssue[],
 		get valid() {
 			return this.issues.length === 0;
@@ -35,7 +41,7 @@ export default function Form($props: FormProps) {
 
 	// Set the context to pass down to Fields
 	let context: FormContext = {
-		schema: $props.schema,
+		schema: $props?.schema,
 		state: $state,
 		validate: handleValidate
 	};
@@ -43,7 +49,7 @@ export default function Form($props: FormProps) {
 	$context[FormContextName] = context;
 
 	async function validate() {
-		if ($props.schema) {
+		if ($props?.schema) {
 			const validator = $props.schema["~standard"];
 			let result = validator.validate($props.data);
 			if (result instanceof Promise) {
@@ -77,7 +83,7 @@ export default function Form($props: FormProps) {
 		}
 
 		// Dispatch the submit event for the user to handle
-		if ($props.onsubmit) {
+		if ($props?.onsubmit) {
 			let userSubmit = $props.onsubmit(e);
 			if (userSubmit instanceof Promise) {
 				userSubmit = await userSubmit;
@@ -118,9 +124,10 @@ export default function Form($props: FormProps) {
 
 	@render {
 		<form
-			{$props.id}
-			class={`torp-form ${$props.class ?? ""}`.trim()}
-			method="POST"
+			{$props?.id}
+			class={`torp-form ${$props?.class ?? ""}`.trim()}
+			method={$props?.method ?? "POST"}
+			enctype={$props?.enctype ?? ($state.hasFile ? "multipart/form-data" : undefined)}
 			onsubmit={handleSubmit}
 			@// Set novalidate only if JS is enabled (to override HTML validation)
 			onmount={(e) => e.novalidate = true }

package/dist/Form/FormTypes.ts

@@ -11,6 +11,11 @@ export interface ValidationIssue {
 export interface FormContext {
 	schema?: StandardSchemaV1;
 	state: {
+		/**
+		 * Whether there is a file input in the form. If so, the form's enctype
+		 * will be set to `multipart/form-data`
+		 */
+		hasFile: boolean;
 		issues: ValidationIssue[];
 	};
 	validate: () => void;

package/dist/Form/Input.torp

@@ -20,15 +20,20 @@ interface InputProps {
 	maxlength?: number,
 	/** An ARIA label for describing the input to screen readers when there is no associated label element */
 	ariaLabel?: string,
+	/** Raised on change */
+	onchange?: (e: Event) => void,
+	/** Raised on input */
+	oninput?: (e: Event) => void,
 };
 
 /**
  * A standard input in a form.
  */
-export default function Input($props: InputProps) {
-	$props ??= $watch({});
-	$props.id ??= getId();
-	$props.type ??= "text";
+export default function Input($props: InputProps | undefined) {
+	let defaultId = getId();
+
+	let type = $props?.type ?? "text";
+	let name = $props?.name
 
 	let blurred = false;
 
@@ -36,13 +41,13 @@ export default function Input($props: InputProps) {
 	const formContext = $context[FormContextName] as FormContext;
 	const fieldContext = $context[FieldContextName] as FieldContext;
 	if (fieldContext) {
-		$props.name ??= fieldContext.name;
+		name ??= fieldContext.name;
 	}
 
 	// Use the FieldContext's state, or create a new one
 	let $state = fieldContext?.state ?? $watch({
-		inputId: $props.id,
-		value: $props.value,
+		inputId: $props?.id ?? defaultId,
+		value: $props?.value,
 		errors: {} as Record<string, string>,
 		valid: false,
 		message: "",
@@ -50,11 +55,13 @@ export default function Input($props: InputProps) {
 
 	// Binding
 	$run(() => {
-		$props.value = $state.value;
+		if ($props !== undefined) {
+			$props.value = $state.value;
+		}
 	});
 
 	// Set the input ID now that we know it and it will get linked with the associated label
-	$state.inputId = $props.id;
+	$state.inputId = $props?.id ?? defaultId;
 
 	// NOTE: Adapted this from https://stackoverflow.com/a/57393751,
 	// not sure if it's still a good way to do things
@@ -66,6 +73,9 @@ export default function Input($props: InputProps) {
 		if (fieldContext && blurred) {
 			fieldContext.validate();
 		}
+		if ($props?.oninput) {
+			$props.oninput(e);
+		}
 	}
 
 	function handleBlur() {
@@ -77,16 +87,17 @@ export default function Input($props: InputProps) {
 
 	@render {
 		<input
-			{$props.id}
-			class={`torp-input ${$props.class ?? ""}`.trim()}
-			{$props.name}
+			id={$props?.id ?? defaultId}
+			class={`torp-input ${$props?.class ?? ""}`.trim()}
+			{type}
+			{name}
 			&value={$state.value}
-			{$props.type}
-			{$props.placeholder}
-			{$props.readonly}
-			{$props.maxlength}
-			aria-label={$props.ariaLabel}
+			{$props?.placeholder}
+			{$props?.readonly}
+			{$props?.maxlength}
+			aria-label={$props?.ariaLabel}
 			data-valid={$state.valid ? "valid" : "invalid"}
+			onchange={$props?.onchange}
 			oninput={handleInput}
 			onblur={handleBlur}
 		/>

package/dist/Form/Label.torp

@@ -10,7 +10,7 @@ interface LabelProps {
 /**
  * A label to describe the contents of an input in a form.
  */
-export default function Label($props?: LabelProps) {
+export default function Label($props: LabelProps | undefined) {
 	// Get stuff out of the FieldContext
 	const context = $context[FieldContextName] as FieldContext;
 	if (!context) {

package/dist/Form/Message.torp

@@ -11,7 +11,7 @@ interface MessageProps {
  * A validation message to show when the contents of an input component have
  * problems that need to be fixed.
  */
-export default function Message($props?: MessageProps) {
+export default function Message($props: MessageProps | undefined) {
 	// Get stuff out of the FieldContext
 	const context = $context[FieldContextName] as FieldContext;
 	if (!context) {

package/dist/Form/Option.torp

@@ -0,0 +1,24 @@
+import getId from "../utils/getId";
+import { FormContextName, FieldContextName, type FormContext, type FieldContext } from "./FormTypes";
+
+interface OptionProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The data value that this option has */
+	value?: any,
+};
+
+/**
+ * An option in a select.
+ */
+export default function Option($props: OptionProps | undefined) {
+	@render {
+		<option
+			{$props?.id}
+			class={`torp-option ${$props?.class ?? ""}`.trim()}
+			&value={$state.value}
+		/>
+	}
+}