@torpor/ui 0.2.1 → 0.3.0

package/src/Form/Form.torp

@@ -18,11 +18,9 @@ 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 ?? {},
 		issues: [] as ValidationIssue[],
 		get valid() {
 			return this.issues.length === 0;
@@ -35,7 +33,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 +41,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 +75,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,8 +116,8 @@ export default function Form($props: FormProps) {
 
 	@render {
 		<form
-			{$props.id}
-			class={`torp-form ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-form ${$props?.class ?? ""}`.trim()}
 			method="POST"
 			onsubmit={handleSubmit}
 			@// Set novalidate only if JS is enabled (to override HTML validation)

package/src/Form/Input.torp

@@ -25,10 +25,11 @@ interface InputProps {
 /**
  * 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 +37,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 +51,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
@@ -77,15 +80,15 @@ 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"}
 			oninput={handleInput}
 			onblur={handleBlur}

package/src/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/src/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/src/Menu/Menu.torp

@@ -1,3 +1,5 @@
+import { ContextualContextName } from "../Contextual/ContextualTypes";
+import { ModalContextName } from "../Modal/ModalTypes";
 import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes";
 import {
 	MenuContextName,
@@ -26,27 +28,26 @@ interface MenuProps {
  *
  * ```
  * <Menu>
- *     <MenuButton />
- *     <MenuSeparator /> (optional)
- *     <MenuGroup> (optional)
- *         <MenuButton />
- *     </MenuGroup>
+ * 	<MenuButton />
+ * 	<MenuSeparator /> (optional)
+ * 	<MenuGroup> (optional)
+ * 		<MenuButton />
+ * 	</MenuGroup>
  * </Menu>
  * ```
  */
-export default function Menu($props: MenuProps) {
-	$props ??= $watch({});
-
+export default function Menu($props: MenuProps | undefined) {
 	// A collection containing the state and some functions for each item
 	let itemStates: ItemState[] = [];
 	let focusIndex = -1;
 
 	// Get stuff out of the PopoverContext
-	const popoverContext = $context[PopoverContextName] as PopoverContext;
+	// HACK: share state in PopupState and extend in context/modal/popover
+	const popoverContext = $context[ContextualContextName] ?? $context[ModalContextName] ?? $context[PopoverContextName] as PopoverContext;
 	if (!popoverContext) {
-		throw new Error("Menu must be contained within a Contextual, Prompt or Popover");
+		throw new Error("Menu must be contained within a Context, Modal or Popover");
 	}
-	const { setVisible, handleButton, modal, visible } = popoverContext;
+	const { setVisible, handleButton, visible } = popoverContext;
 
 	// Check whether this is a menu in a popout
 	const popoutContext = $context[MenuPopoutContextName] as MenuPopoutContext;
@@ -77,7 +78,7 @@ export default function Menu($props: MenuProps) {
 	}
 
 	function registerItem(setFocused: () => void) {
-		// Add the item"s state to the array and return its index
+		// Add the item's state to the array and return its index
 		const newItemState: ItemState = {
 			setFocused
 		};
@@ -156,11 +157,11 @@ export default function Menu($props: MenuProps) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu ${$props?.class ?? ""}`.trim()}
 			tabindex="-1"
 			role="menu"
-			aria-label={$props.ariaLabel}
+			aria-label={$props?.ariaLabel}
 			aria-orientation="vertical"
 		>
 			<slot />

package/src/Menu/MenuButton.torp

@@ -9,15 +9,17 @@ interface MenuButtonProps {
 	value?: any,
 	/** Whether this button is disabled */
 	disabled?: boolean,
+	/** Raised when the button is clicked */
+	onclick?: (e: MouseEvent) => void,
+	/** Raised when a key is pressed down */
+	onkeydown?: (e: KeyboardEvent) => void,
 }
 
 /**
  * A button that is placed in a Menu or MenuGroup and signals a response by a user.
  *
  */
-export default function MenuButton($props: MenuButtonProps) {
-	$props ??= $watch({});
-
+export default function MenuButton($props: MenuButtonProps | undefined) {
 	let button: HTMLButtonElement;
 
 	// Get stuff out of the MenuContext
@@ -30,14 +32,18 @@ export default function MenuButton($props: MenuButtonProps) {
 	// Register this item with the parent Menu and store the index
 	const { index } = registerItem(setFocused);
 
-	function handleKeyDown(e) {
+	function handleKeyDown(e: KeyboardEvent) {
 		handleItemKey(e);
-		if ($props.onkeydown) $props.onkeydown(e);
+		if ($props?.onkeydown) {
+			$props.onkeydown(e);
+		}
 	}
 
-	function handleClick(e) {
-		handleButton($props.value);
-		if ($props.onclick) $props.onclick(e);
+	function handleClick(e: MouseEvent) {
+		handleButton($props?.value);
+		if ($props?.onclick) {
+			$props.onclick(e);
+		}
 	}
 
 	function setFocused() {
@@ -46,13 +52,13 @@ export default function MenuButton($props: MenuButtonProps) {
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-button ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-button ${$props?.class ?? ""}`.trim()}
 			type="button"
-			{$props.disabled}
+			{$props?.disabled}
 			role="menuitem"
-			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={$props.disabled ? "true" : undefined}
+			aria-disabled={$props?.disabled ? "true" : undefined}
+			data-disabled={$props?.disabled ? "true" : undefined}
 			onkeydown={handleKeyDown}
 			onclick={handleClick}
 			onfocus={() => handleItemFocus(index)}

package/src/Menu/MenuCheck.torp

@@ -14,6 +14,8 @@ interface MenuCheckProps {
 	checked?: boolean,
 	/** Whether this item is disabled */
 	disabled?: boolean,
+	/** Raised when the checkbox is clicked */
+	onclick?: (e: MouseEvent) => void,
 }
 
 /**
@@ -21,15 +23,15 @@ interface MenuCheckProps {
  * option on or off.
  *
  */
-export default function MenuCheck($props: MenuCheckProps) {
-	$props ??= $watch({});
-
+export default function MenuCheck($props: MenuCheckProps | undefined) {
 	let $state = $watch({
-		checked: $props.checked
+		checked: $props?.checked ?? false
 	});
 
 	$run(() => {
-		$props.checked = $state.checked;
+		if ($props !== undefined) {
+			$props.checked = $state.checked;
+		}
 	});
 
 	let button: HTMLButtonElement;
@@ -54,22 +56,24 @@ export default function MenuCheck($props: MenuCheckProps) {
 		button.focus();
 	}
 
-	function handleClick() {
+	function handleClick(e: MouseEvent) {
 		$state.checked = !$state.checked;
-		if ($props.onclick) $props.onclick();
+		if ($props?.onclick) {
+			$props.onclick(e);
+		}
 	}
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-check ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-check ${$props?.class ?? ""}`.trim()}
 			type="button"
-			{$props.disabled}
+			{$props?.disabled}
 			role="menuitemcheckbox"
-			aria-checked={$props.checked ? "true" : "false"}
-			aria-disabled={$props.disabled ? "true" : undefined}
-			data-state={$props.checked ? "checked" : "unchecked"}
-			data-disabled={$props.disabled ? "true" : undefined}
+			aria-checked={$props?.checked ? "true" : "false"}
+			aria-disabled={$props?.disabled ? "true" : undefined}
+			data-state={$props?.checked ? "checked" : "unchecked"}
+			data-disabled={$props?.disabled ? "true" : undefined}
 			onkeydown={handleItemKey}
 			onclick={handleClick}
 			onfocus={() => handleItemFocus(index)}

package/src/Menu/MenuGroup.torp

@@ -11,17 +11,15 @@ interface MenuGroupProps {
 /**
  * A container for a logical group of menu items.
  */
-export default function MenuGroup($props: MenuGroupProps) {
-	$props ??= $watch({});
-
+export default function MenuGroup($props: MenuGroupProps | undefined) {
 	// TODO: Intercept the context to steal toggleItem??
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-group ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-group ${$props?.class ?? ""}`.trim()}
 			role="group"
-			aria-label={$props.ariaLabel}
+			aria-label={$props?.ariaLabel}
 		>
 			<slot />
 		</div>

package/src/Menu/MenuIndicator.torp

@@ -13,9 +13,7 @@ interface MenuIndicatorProps {
  * An indicator for a MenuCheck or MenuRadio component, which is displayed
  * when the value of checked is true.
  */ 
-export default function MenuIndicator($props: MenuIndicatorProps) {
-	$props ??= $watch({});
-
+export default function MenuIndicator($props: MenuIndicatorProps | undefined) {
 	// Get stuff out of the MenuButtonContext
 	const context = $context[MenuButtonContextName] as MenuButtonContext;
 	if (!context) {
@@ -26,10 +24,10 @@ export default function MenuIndicator($props: MenuIndicatorProps) {
 	@render {
 		@if ($state.checked) {
 			<div
-				{$props.id}
-				class={`torp-menu-indicator ${$props.class ?? ""}`.trim()}
-				aria-disabled={$props.disabled ? "true" : undefined}
-				data-disabled={$props.disabled ? "true" : undefined}
+				{$props?.id}
+				class={`torp-menu-indicator ${$props?.class ?? ""}`.trim()}
+				aria-disabled={$props?.disabled ? "true" : undefined}
+				data-disabled={$props?.disabled ? "true" : undefined}
 			>
 				<slot />
 			</div>

package/src/Menu/MenuPopout.torp

@@ -7,12 +7,12 @@ interface MenuPopoutProps {
 	class?: string,
 	/** Whether the popout is visible */
 	visible?: boolean,
-	/** Called when the popout is opened or closed */
+	/** Raised when the popout is opened or closed */
 	ontoggle?: (open: boolean) => void,
-	/** Called when the popout has opened */
+	/** Raised when the popout has opened */
 	onopen?: () => void,
-	/** Called when the popout has closed */
-	onclose?: () => void,
+	/** Raised when the popout has closed */
+	onclose?: (result: any) => void,
 }
 
 /**
@@ -22,17 +22,14 @@ interface MenuPopoutProps {
  *
  * ```
  * <MenuPopout>
- *     <MenuPopoutTrigger /> (optional)
+ * 	<MenuPopoutTrigger /> (optional)
  * 	<MenuPopoutContent />
  * </MenuPopout>
  * ```
  */
-export default function MenuPopout($props: MenuPopoutProps) {
-	$props ??= $watch({});
-	$props.visible ??= false;
-
+export default function MenuPopout($props: MenuPopoutProps | undefined) {
 	let $state = $watch({
-		visible: $props.visible
+		visible: $props?.visible ?? false
 	});
 
 	let result: any;
@@ -50,9 +47,9 @@ export default function MenuPopout($props: MenuPopoutProps) {
 
 	let firstToggle = true;
 	$run(() => {
-		const ontoggle = $props.ontoggle;
-		const onopen = $props.onopen;
-		const onclose = $props.onclose;
+		const ontoggle = $props?.ontoggle;
+		const onopen = $props?.onopen;
+		const onclose = $props?.onclose;
 		const visible = $state.visible;
 		if (firstToggle) {
 			firstToggle = false;
@@ -72,8 +69,8 @@ export default function MenuPopout($props: MenuPopoutProps) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-popout ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-popout ${$props?.class ?? ""}`.trim()}
 			onmouseleave={handleMouseLeave}
 		>
 			<slot />

package/src/Menu/MenuPopoutContent.torp

@@ -16,11 +16,7 @@ interface MenuPopoutContentProps {
 /**
  * The content that is displayed for a MenuPopout when it is open.
  */
-export default function MenuPopoutContent($props: MenuPopoutContentProps) {
-	$props ??= $watch({});
-	$props.side ??= "right";
-	$props.alignment ??= "start";
-
+export default function MenuPopoutContent($props: MenuPopoutContentProps | undefined) {
 	let div: HTMLDivElement;
 	let shown = false;
 
@@ -65,14 +61,16 @@ export default function MenuPopoutContent($props: MenuPopoutContentProps) {
 			throw new Error("MenuPopoutContent must have an anchor element");
 		}
 
-		setPopoverPosition(popoutContext.anchorElement, div, $props.side, $props.alignment);
+		let side = $props?.side ?? "right";
+		let alignment = $props?.alignment ?? "start";
+		setPopoverPosition(popoutContext.anchorElement, div, side, alignment);
 	}
 
 	@render {
 		@if ($state.visible) {
 			<div
-				{$props.id}
-				class={`torp-menu-popout-content ${$props.class ?? ""}`.trim()}
+				{$props?.id}
+				class={`torp-menu-popout-content ${$props?.class ?? ""}`.trim()}
 				&ref={div}
 				onmount={show}
 			>

package/src/Menu/MenuPopoutTrigger.torp

@@ -19,10 +19,8 @@ interface MenuPopoutTriggerProps {
 /**
  * A button that is placed in a Menu or MenuGroup and signals a response by a user.
  */
-export default function MenuPopoutTrigger($props: MenuPopoutTriggerProps) {
-	$props ??= $watch({});
-	$props.hoverDelay ??= 500;
-	$props.disabled ??= false;
+export default function MenuPopoutTrigger($props: MenuPopoutTriggerProps | undefined) {
+	let defaultHoverDelay = 500;
 
 	let button: HTMLButtonElement;
 	let interval: NodeJS.Timeout | undefined;
@@ -72,16 +70,16 @@ export default function MenuPopoutTrigger($props: MenuPopoutTriggerProps) {
 	}
 
 	function handleMouseEnter() {
-		if ($props.disabled) return;
+		if ($props?.disabled) return;
 
 		// Handle the hover after a delay
 		if (!interval) {
-			interval = setTimeout(() => setVisible(true), $props.hoverDelay);
+			interval = setTimeout(() => setVisible(true), $props?.hoverDelay ?? defaultHoverDelay);
 		}
 	}
 
 	function handleMouseLeave() {
-		if ($props.disabled) return;
+		if ($props?.disabled) return;
 
 		// Prevent short hovers or touches from firing the event
 		if (interval) {
@@ -91,26 +89,26 @@ export default function MenuPopoutTrigger($props: MenuPopoutTriggerProps) {
 	}
 
 	function handleMouseMove() {
-		if ($props.disabled) return;
+		if ($props?.disabled) return;
 
 		// Reset the interval on mouse move
 		if (interval) {
 			clearTimeout(interval);
-			interval = setTimeout(() => setVisible(true), $props.hoverDelay);
+			interval = setTimeout(() => setVisible(true), $props?.hoverDelay ?? defaultHoverDelay);
 		}
 	}
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-popout-trigger ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-popout-trigger ${$props?.class ?? ""}`.trim()}
 			type="button"
-			{$props.disabled}
+			{$props?.disabled}
 			role="menuitem"
 			aria-haspopup="true"
 			aria-expanded={($state.visible ?? false).toString()}
-			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={$props.disabled ? "true" : undefined}
+			aria-disabled={$props?.disabled ? "true" : undefined}
+			data-disabled={$props?.disabled ? "true" : undefined}
 			onkeydown={handlePopoutKey}
 			onclick={handleClick}
 			onfocus={() => handleItemFocus(index)}

package/src/Menu/MenuRadio.torp

@@ -24,15 +24,15 @@ interface MenuRadioProps {
  * A button that is placed in a Menu or MenuGroup to allow the user to select
  * from a number of options.
  */
-export default function MenuRadio($props: MenuRadioProps) {
-	$props ??= $watch({});
-
+export default function MenuRadio($props: MenuRadioProps | undefined) {
 	let $state = $watch({
-		checked: $props.checked,
+		checked: $props?.checked ?? false,
 	});
 
 	$run(() => {
-		$props.checked = $state.checked;
+		if ($props !== undefined) {
+			$props.checked = $state.checked;
+		}
 	});
 
 	let button: HTMLButtonElement;
@@ -55,7 +55,7 @@ export default function MenuRadio($props: MenuRadioProps) {
 	const { index } = registerItem(setFocused);
 
 	// Register this item with the parent MenuRadioGroup
-	registerItemInGroup($props.value, setChecked);
+	registerItemInGroup($props?.value ?? "", setChecked);
 
 	// Set the context to pass down to items
 	let context: MenuButtonContext = {
@@ -73,21 +73,21 @@ export default function MenuRadio($props: MenuRadioProps) {
 
 	function handleClick() {
 		if (!$state.checked) {
-			toggleItem($props.value);
+			toggleItem($props?.value ?? "");
 		}
 	}
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-radio ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-radio ${$props?.class ?? ""}`.trim()}
 			type="button"
-			{$props.disabled}
+			{$props?.disabled}
 			role="menuitemradio"
-			aria-checked={$props.checked}
-			aria-disabled={$props.disabled ? "true" : undefined}
-			data-state={$props.checked ? "checked" : "unchecked"}
-			data-disabled={$props.disabled ? "true" : undefined}
+			aria-checked={$props?.checked}
+			aria-disabled={$props?.disabled ? "true" : undefined}
+			data-state={$props?.checked ? "checked" : "unchecked"}
+			data-disabled={$props?.disabled ? "true" : undefined}
 			onkeydown={handleItemKey}
 			onclick={handleClick}
 			onfocus={() => handleItemFocus(index)}