@torpor/ui 0.2.0 → 0.3.0

package/src/Menu/MenuPopoutTrigger.torp

@@ -5,15 +5,22 @@ import {
 	type MenuPopoutContext
 } from "./MenuTypes";
 
+interface MenuPopoutTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The delay before showing the popout, in milliseconds */
+	hoverDelay?: number,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a Menu or MenuGroup and signals a response by a user.
- *
- * @prop {number} hoverDelay -- The delay before showing the popout, in milliseconds
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function MenuPopoutTrigger() {
-	$props.hoverDelay ??= 500;
-	$props.disabled ??= false;
+export default function MenuPopoutTrigger($props: MenuPopoutTriggerProps | undefined) {
+	let defaultHoverDelay = 500;
 
 	let button: HTMLButtonElement;
 	let interval: NodeJS.Timeout | undefined;
@@ -63,16 +70,16 @@ export default function MenuPopoutTrigger() {
 	}
 
 	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) {
@@ -82,26 +89,26 @@ export default function MenuPopoutTrigger() {
 	}
 
 	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

@@ -7,21 +7,32 @@ import {
 	type MenuRadioGroupContext
 } from "./MenuTypes";
 
+interface MenuRadioProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value of the item */
+	value?: string,
+	/** Whether this item is checked */
+	checked?: boolean,
+	/** Whether this item is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a Menu or MenuGroup to allow the user to select
  * from a number of options.
- *
- * @prop {string} value -- The value of the item
- * @prop {boolean} checked -- Whether this item is checked
- * @prop {boolean} disabled -- Whether this item is disabled
  */
-export default function MenuRadio() {
+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;
@@ -44,7 +55,7 @@ export default function MenuRadio() {
 	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 = {
@@ -62,21 +73,21 @@ export default function MenuRadio() {
 
 	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)}

package/src/Menu/MenuRadioGroup.torp

@@ -4,17 +4,36 @@ import {
 	type RadioGroupItemState
 } from "./MenuTypes";
 
+interface MenuRadioGroupProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the menu to screen readers */
+	ariaLabel?: string,
+	/** The value of the checked MenuRadio */
+	value?: string | undefined,
+	/** Raised when the checked item has changed */
+	onchange?: (value: any) => void,
+}
+
 /**
  * A container for a logical group of menu RadioGroup items.
- *
- * @prop {string} ariaLabel -- An ARIA label for describing the menu to screen readers
- * @prop {string | undefined} value -- The value of the checked MenuRadio
- * @prop {(any) => void} onchange - Called when the checked item has changed
  */
-export default function MenuRadioGroup() {
+export default function MenuRadioGroup($props: MenuRadioGroupProps | undefined) {
 	// A collection containing the state and some functions for each item
 	let itemStates: RadioGroupItemState[] = [];
 
+	let $state = $watch({
+		value: $props?.value
+	});
+
+	$run(() => {
+		if ($props !== undefined) {
+			$props.value = $state.value;
+		}
+	});
+
 	// Set the context to pass down to items
 	let context: MenuRadioGroupContext = {
 		registerItemInGroup,
@@ -24,11 +43,11 @@ export default function MenuRadioGroup() {
 
 	$mount(() => {
 		// Set the initial checked item
-		setValue($props.value);
+		setValue($props?.value);
 	});
 
 	function registerItemInGroup(itemValue: string, setChecked: (value: boolean) => void) {
-		// Add the item"s state to the array
+		// Add the item's state to the array
 		const newItemState: RadioGroupItemState = {
 			value: itemValue,
 			checked: false,
@@ -52,11 +71,11 @@ export default function MenuRadioGroup() {
 		}
 
 		// Set the value
-		if ($props.value !== newValue) {
-			$props.value = newValue;
+		if ($state.value !== newValue) {
+			$state.value = newValue;
 
-			if ($props.onchange) {
-				$props.onchange($props.value);
+			if ($props?.onchange) {
+				$props?.onchange($props?.value);
 			}
 		}
 	}
@@ -70,15 +89,15 @@ export default function MenuRadioGroup() {
 				newValue = item.value;
 			}
 		}
-		$props.value = newValue;
+		$state.value = newValue;
 	}
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-radio-group ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-radio-group ${$props?.class ?? ""}`.trim()}
 			role="group"
-			aria-label={$props.ariaLabel}
+			aria-label={$props?.ariaLabel}
 		>
 			<slot />
 		</div>

package/src/Menu/MenuSeparator.torp

@@ -1,11 +1,19 @@
+
+interface MenuSeparatorProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * An element in a menu that separates logical sets of menu items.
  */
-export default function MenuSeparator() {
+export default function MenuSeparator($props: MenuSeparatorProps | undefined) {
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-separator ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-separator ${$props?.class ?? ""}`.trim()}
 			role="separator"
 		>
 			<slot />

package/src/Menu/MenuTypes.ts

@@ -7,7 +7,7 @@ export interface MenuContext {
 	setVisible: (value: boolean, result?: any) => void;
 
 	/** Called from a MenuButton to close the Menu and return a result */
-	handleTrigger: (type: "confirm" | "cancel" | undefined, value?: any) => void;
+	handleButton: (type: "confirm" | "cancel" | undefined, value?: any) => void;
 
 	/** Called from a MenuButton when its button is focused */
 	handleItemFocus: (index: number) => void;
@@ -15,10 +15,7 @@ export interface MenuContext {
 	/** Called from a MenuButton when a key is pressed */
 	handleItemKey: (e: KeyboardEvent) => void;
 
-	state: {
-		/** Whether the Menu is visible. Writable so that it can be subscribed to by children */
-		visible: boolean;
-	};
+	state: MenuState;
 
 	/** The element that caused this Menu to be shown */
 	anchorElement?: HTMLElement;
@@ -27,6 +24,11 @@ export interface MenuContext {
 	registerItem: (setFocused: () => void) => { index: number };
 }
 
+export interface MenuState {
+	/** Whether the Menu is visible */
+	visible: boolean;
+}
+
 export interface MenuButtonContext {
 	state: {
 		checked: boolean;

package/src/MenuBar/MenuBar.torp

@@ -1,5 +1,16 @@
 import { MenuBarContextName, type MenuBarContext, type ItemState } from "./MenuBarTypes";
 
+interface MenuBarProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the menu to screen readers */
+	ariaLabel?: string,
+	/** The orientation of the menu, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+}
+
 /**
  * A menu bar, similar to that shown at the top of Windows applications or at the top of the screen on Macs.
  *
@@ -9,20 +20,17 @@ import { MenuBarContextName, type MenuBarContext, type ItemState } from "./MenuB
  *
  * ```
  * <MenuBar>
- *     <MenuBarItem>
- *         <MenuBarItemTrigger />
- *         <MenuBarItemContent>
- *             <Menu />
- *         </MenuBarItemContent>
- *     </MenuBarItem>
+ * 	<MenuBarItem>
+ * 		<MenuBarItemTrigger />
+ * 		<MenuBarItemContent>
+ * 			<Menu />
+ * 		</MenuBarItemContent>
+ * 	</MenuBarItem>
  * </MenuBar>
  * ```
- *
- * @prop {string} ariaLabel -- An ARIA label for describing the menu to screen readers
- * @prop {"horizontal" | "vertical"} orientation -- The orientation of the menu, which affects keyboard navigation
  */
-export default function MenuBar() {
-	$props.orientation ??= "horizontal";
+export default function MenuBar($props: MenuBarProps | undefined) {
+	let orientation = $props?.orientation ?? "horizontal";
 
 	let $state = $watch({
 		active: false,
@@ -43,7 +51,7 @@ export default function MenuBar() {
 	$context[MenuBarContextName] = context;
 
 	function registerItem(setVisible: (value: boolean) => void, 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 = {
 			setVisible,
 			setFocused
@@ -137,12 +145,12 @@ export default function MenuBar() {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-bar ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar ${$props?.class ?? ""}`.trim()}
 			tabindex="-1"
 			role="menubar"
-			aria-label={$props.ariaLabel}
-			aria-orientation={$props.orientation}
+			aria-label={$props?.ariaLabel}
+			aria-orientation={orientation}
 		>
 			<slot />
 		</div>

package/src/MenuBar/MenuBarItem.torp

@@ -6,6 +6,21 @@ import {
 } from "./MenuBarTypes";
 import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes";
 
+interface MenuBarItemProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the item is visible */
+	visible?: boolean,
+	/** Raised when the item is opened or closed */
+	ontoggle?: (visible: boolean) => void,
+	/** Raised when the item has opened */
+	onopen?: () => void,
+	/** Raised when the item has closed */
+	onclose?: (result: any) => void,
+}
+
 /**
  * A popout that is attached to a menubar button and can be used to show a submenu.
  *
@@ -13,21 +28,14 @@ import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes
  *
  * ```
  * <MenuBarItem>
- *     <MenuBarItemTrigger /> (optional)
- *     <MenuBarItemContent />
+ * 	<MenuBarItemTrigger /> (optional)
+ * 	<MenuBarItemContent />
  * </MenuBarItem>
  * ```
- *
- * @prop {boolean} visible -- Whether the item is visible
- * @prop {(boolean) => void} ontoggle -- Called when the item is opened or closed
- * @prop {() => void} onopen -- Called when the item has opened
- * @prop {() => void} onclose -- Called when the item has closed
  */
-export default function MenuBarItem() {
-	$props.visible ??= false;
-
+export default function MenuBarItem($props: MenuBarItemProps | undefined) {
 	let $state = $watch({
-		visible: $props.visible
+		visible: $props?.visible ?? false
 	});
 
 	let result: any;
@@ -72,9 +80,9 @@ export default function MenuBarItem() {
 
 	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;
@@ -95,8 +103,8 @@ export default function MenuBarItem() {
 
 	@render {
 		<div 
-			{$props.id}
-			class={`torp-menu-bar-item ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar-item ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/src/MenuBar/MenuBarItemContent.torp

@@ -7,16 +7,21 @@ import {
 	type MenuBarItemContext
 } from "./MenuBarTypes";
 
+interface MenuBarItemContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Where the popout will be shown, relative to the popout button */
+	side?: "top" | "right" | "bottom" | "left",
+	/** How the popout will be aligned, relative to the popout button */
+	alignment?: "start" | "center" | "end",
+}
+
 /**
  * The content that is displayed for a MenuBarItem when it is open.
- *
- * @prop {"top" | "right" | "bottom" | "left"} side -- Where the popout will be shown, relative to the popout button
- * @prop {"start" | "center" | "end"} alignment -- How the popout will be aligned, relative to the popout button
  */
-export default function MenuBarItemContent() {
-	$props.side ??= "bottom";
-	$props.alignment ??= "start";
-
+export default function MenuBarItemContent($props: MenuBarItemContentProps | undefined) {
 	let div: HTMLDivElement;
 	let closeOnClick = false;
 	let shown = false;
@@ -80,7 +85,7 @@ export default function MenuBarItemContent() {
 
 	function handleDocumentClick(e: MouseEvent) {
 		if (closeOnClick && !div.contains(e.target as HTMLElement)) {
-			context.active = false;
+			//context.active = false;
 			setVisible(false);
 		}
 	}
@@ -90,14 +95,16 @@ export default function MenuBarItemContent() {
 			throw new Error("MenuBarItemContent must have an anchor element");
 		}
 
-		setPopoverPosition(itemContext.anchorElement, div, $props.side, $props.alignment);
+		let side = $props?.side ?? "bottom";
+		let alignment = $props?.alignment ?? "start";
+		setPopoverPosition(itemContext.anchorElement, div, side, alignment);
 	}
 
 	@render {
 		@if ($state.visible) {
 			<div
-				{$props.id}
-				class={`torp-menu-bar-item-content ${$props.class ?? ""}`.trim()}
+				{$props?.id}
+				class={`torp-menu-bar-item-content ${$props?.class ?? ""}`.trim()}
 				&ref={div}
 				onmount={show}
 			>

package/src/MenuBar/MenuBarItemTrigger.torp

@@ -5,14 +5,20 @@ import {
 	type MenuBarItemContext
 } from "./MenuBarTypes";
 
+interface MenuBarItemTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a MenuBar and opens a submenu.
  *
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function MenuBarItemTrigger() {
-	$props.disabled ??= false;
-
+export default function MenuBarItemTrigger($props: MenuBarItemTriggerProps | undefined) {
 	let button: HTMLButtonElement;
 
 	// Get stuff out of the MenuBarContext
@@ -67,15 +73,15 @@ export default function MenuBarItemTrigger() {
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-bar-item-button ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar-item-button ${$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={handleKey}
 			onclick={handleClick}
 			onfocus={() => handleButtonFocus(index)}

package/src/Modal/Modal.torp

@@ -0,0 +1,118 @@
+import { ModalContextName, type ModalContext, type ModalState } from "./ModalTypes";
+
+interface ModalProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the modal is visible  */
+	visible?: boolean,
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the modal is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the modal has opened */
+	onopen?: () => void,
+	/** Raised when the modal has closed */
+	onclose?: (result: any) => void,
+}
+
+/**
+ * A modal window that can be used to show rich content or obtain information from a user.
+ *
+ * See [the WAI ARIA guidelines for Modals](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/).
+ *
+ * The structure of a Modal is:
+ *
+ * ```
+ * <Modal>
+ * 	<ModalOverlay />
+ * 	<ModalTrigger /> (optional)
+ * 	<ModalContent />
+ * </Modal>
+ * ```
+ */
+export default function Modal($props: ModalProps | undefined) {
+	let $state: ModalState = $watch({
+		visible: false,
+	})
+
+	// Sync props and state
+	$run(() => {
+		$state.visible = $props?.visible ?? false;
+	});
+	$run(() => {
+		if ($props !== undefined) {
+			$props.visible = $state.visible;
+		}
+	});
+
+	let result: any;
+
+	// Set the context to pass down to items
+	let context: ModalContext = {
+		handleButton,
+		handleClickOutside,
+		state: $state,
+	};
+	$context[ModalContextName] = context;
+
+	// Dispatch the toggle event when the modal is opened or closed
+	let firstToggle = true;
+	$run(() => {
+		const ontoggle = $props?.ontoggle;
+		const onopen = $props?.onopen;
+		const onclose = $props?.onclose;
+		const visible = $state.visible;
+		if (firstToggle) {
+			firstToggle = false;
+		} else {
+			if (ontoggle) ontoggle(visible);
+			if (visible) {
+				if (onopen) onopen()
+			} else {
+				if (onclose) onclose(result);
+			}
+		}
+	});
+
+	function handleButton(type: "confirm" | "cancel" | undefined, value?: any) {
+		// Get the button's result
+		switch (type) {
+			case "confirm": {
+				result = value || true;
+				break;
+			}
+			case "cancel": {
+				result = value || false;
+				break;
+			}
+			default: {
+				result = value;
+				break;
+			}
+		}
+
+		// Hide the modal
+		$state.visible = false;
+
+		// Call the callback
+		if ($props?.callback) {
+			$props?.callback(result);
+		}
+	}
+
+	function handleClickOutside(e: MouseEvent) {
+		e.preventDefault();
+		$state.visible = false;
+	}
+
+	@render {
+		<div
+			{$props?.id}
+			class={`torp-modal ${$props?.class ?? ""}`.trim()}
+		>
+			<slot />
+		</div>
+	}
+}