@torpor/ui 0.0.17 → 0.1.0

package/src/Dialog/DialogTypes.ts

@@ -0,0 +1,16 @@
+export const DialogContextName = "Dialog";
+
+export interface DialogContext {
+	handleButton: (type: "confirm" | "cancel" | undefined, value?: any) => void;
+	state: DialogState;
+	anchorElement?: HTMLElement;
+	confirmButton?: HTMLButtonElement;
+	cancelButton?: HTMLButtonElement;
+}
+
+export interface DialogState {
+	dialogId: string;
+	headerId: string;
+	bodyId: string;
+	visible: boolean;
+}

package/src/Dialog/index.ts

@@ -0,0 +1,7 @@
+import Dialog from "./Dialog.torp";
+import DialogBody from "./DialogBody.torp";
+import DialogButton from "./DialogButton.torp";
+import DialogFooter from "./DialogFooter.torp";
+import DialogHeader from "./DialogHeader.torp";
+
+export { Dialog, DialogHeader, DialogBody, DialogFooter, DialogButton };

package/src/Dialog.ts

@@ -0,0 +1,7 @@
+import Dialog from "./Dialog/Dialog.torp";
+import DialogBody from "./Dialog/DialogBody.torp";
+import DialogButton from "./Dialog/DialogButton.torp";
+import DialogFooter from "./Dialog/DialogFooter.torp";
+import DialogHeader from "./Dialog/DialogHeader.torp";
+
+export { Dialog, DialogHeader, DialogBody, DialogFooter, DialogButton };

package/src/NavMenu/NavMenu.torp

@@ -0,0 +1,178 @@
+import {
+	NavMenuContextName,
+	type NavMenuContext,
+	type ItemState,
+	NavMenuPopoutContextName,
+	type NavMenuPopoutContext
+} from "./NavMenuTypes";
+
+/**
+ * A list of links for navigating a website.
+ *
+ * See [the WAI ARIA guidelines for Menus](https://www.w3.org/WAI/ARIA/apg/patterns/menu/).
+ *
+ * The structure of a NavMenu is:
+ *
+ * ```
+ * <NavMenu>
+ *	 <NavMenuLink />
+ *	 <NavMenuSeparator /> (optional)
+ *	 <NavMenuPopout /> (optional)
+ *	 ...
+ * </NavMenu>
+ * ```
+ *
+ * @prop {string | undefined} 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 NavMenu($props: any) {
+	$props.orientation ||= "horizontal";
+
+	// A collection containing the state and some functions for each item
+	let itemStates: ItemState[] = [];
+	let focusIndex = -1;
+
+	// Check whether this is a menu in a popout
+	const popoutContext = $context[NavMenuPopoutContextName] as NavMenuPopoutContext;
+	const inPopout = !!popoutContext;
+	let popoutState = popoutContext?.state;
+
+	// Set the focusFirstElement method in the PopoverContext(s) so that it can be called after everything has been shown
+	if (popoutContext) {
+		popoutContext.focusFirstElement = focusFirstElement;
+	}
+
+	// Set the context to pass down to items
+	let context: NavMenuContext = {
+		handleItemFocus,
+		handleItemKey,
+		registerItem
+	};
+	$context[NavMenuContextName] = context;
+
+	// If the NavMenu is not in a popout, focus its first item. Otherwise the popout will call focusFirstElement, below
+	function handleFocus(e: FocusEvent & { currentTarget: EventTarget & HTMLElement }) {
+		if (!popoutContext && itemStates.length) {
+			itemStates[0].setFocused();
+		}
+	}
+
+	function focusFirstElement() {
+		if (itemStates.length) {
+			itemStates[0].setFocused();
+		}
+	}
+
+	function registerItem(setFocused: () => void) {
+		// Add the item's state to the array and return its index
+		const newItemState: ItemState = {
+			setFocused
+		};
+		itemStates.push(newItemState);
+		itemStates = itemStates;
+		return { index: itemStates.length - 1 };
+	}
+
+	function handleItemFocus(index: number) {
+		focusIndex = index;
+	}
+
+	function handleItemKey(e: KeyboardEvent) {
+		switch (e.key) {
+			case "Esc":
+			case "Escape": {
+				if (inPopout) {
+					e.preventDefault();
+					//setPopoutVisible(false);
+					popoutState.visible = false;
+				}
+				break;
+			}
+			case "Right":
+			case "ArrowRight": {
+				if (orientation === "horizontal") {
+					e.preventDefault();
+					focusItem("next");
+				}
+				break;
+			}
+			case "Left":
+			case "ArrowLeft": {
+				if (orientation === "horizontal") {
+					e.preventDefault();
+					focusItem("previous");
+				}
+				break;
+			}
+			case "Down":
+			case "ArrowDown": {
+				if (orientation === "vertical") {
+					e.preventDefault();
+					focusItem("next");
+				}
+				break;
+			}
+			case "Up":
+			case "ArrowUp": {
+				if (orientation === "vertical") {
+					e.preventDefault();
+					focusItem("previous");
+				} else {
+					// TODO: This should be based on what side the menu shows on
+					// And on the orientation
+					if (inPopout) {
+						e.preventDefault();
+						popoutState.visible = false;
+					}
+				}
+				break;
+			}
+			case "Home": {
+				e.preventDefault();
+				focusItem("start");
+				break;
+			}
+			case "End": {
+				e.preventDefault();
+				focusItem("end");
+				break;
+			}
+		}
+	}
+
+	function focusItem(target: "start" | "previous" | "next" | "end") {
+		switch (target) {
+			case "start": {
+				focusIndex = 0;
+				break;
+			}
+			case "previous": {
+				focusIndex = Math.max(0, focusIndex - 1);
+				break;
+			}
+			case "next": {
+				focusIndex = Math.min(itemStates.length - 1, focusIndex + 1);
+				break;
+			}
+			case "end": {
+				focusIndex = itemStates.length - 1;
+				break;
+			}
+		}
+		itemStates[focusIndex]?.setFocused();
+	}
+
+	@render {
+		<nav
+			id={$props.id}
+			class={`torp-nav-menu ${$props.class ?? ""}`.trim()}
+			tabindex="0"
+			role="menubar"
+			aria-label={$props.ariaLabel}
+			aria-orientation={$props.orientation}
+			onfocus={handleFocus}
+		>
+			<:slot />
+		</nav>
+	}
+}

package/src/NavMenu/NavMenuButton.torp

@@ -0,0 +1,46 @@
+import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
+
+/**
+ * A button that is placed in a NavMenu to carry out a non-navigation action such as logging out.
+ *
+ * @prop {boolean} disabled -- Whether this button is disabled 
+ */
+export default function NavMenuButton($props: any) {
+	/** Set when the item is disabled */
+	let dataDisabled = $props.disabled || undefined;
+
+	let button: HTMLButtonElement;
+
+	// Get stuff out of the NavMenuContext
+	const menuContext = $context[NavMenuContextName] as NavMenuContext;
+	if (!menuContext) {
+		throw new Error("NavMenuButton must be contained within a NavMenu");
+	}
+	const { registerItem, handleItemKey, handleItemFocus } = menuContext;
+
+	// Register this item with the parent NavMenu and store the index
+	const { index } = registerItem(setFocused);
+
+	function setFocused() {
+		button.focus();
+	}
+
+	@render {
+		<button
+			id={$props.id}
+			class={`torp-nav-menu-button ${$props.class ?? ""}`.trim()}
+			type="button"
+			{disabled}
+			role="menuitem"
+			aria-disabled={disabled ? "true" : undefined}
+			data-disabled={dataDisabled}
+			onkeydown
+			onkeydown={handleItemKey}
+			onclick
+			onfocus={() => handleItemFocus(index)}
+			&ref={button}
+		>
+			<:slot />
+		</button>
+	}
+}

package/src/NavMenu/NavMenuElement.torp

@@ -0,0 +1,43 @@
+import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
+
+/**
+ * An element of any type that can be placed in a NavMenu.
+ *
+ * @prop {boolean} disabled -- Whether this button is disabled 
+ * @prop {HTMLElement} element -- An element that can be focused via keyboard navigation
+ */
+export default function NavMenuElement($props: any) {
+	/** Set when the item is disabled */
+	let dataDisabled = $props.disabled || undefined;
+
+	// Get stuff out of the NavMenuContext
+	const menuContext = $context[NavMenuContextName] as NavMenuContext;
+	if (!menuContext) {
+		throw new Error("NavMenuElement must be contained within a NavMenu");
+	}
+	const { registerItem, handleItemKey, handleItemFocus } = menuContext;
+
+	// Register this item with the parent NavMenu and store the index
+	const { index } = registerItem(setFocused);
+
+	function setFocused() {
+		element.focus();
+	}
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-nav-menu-div ${$props.class ?? ""}`.trim()}
+			type="div"
+			role="menuitem"
+			aria-disabled={$props.disabled ? "true" : undefined}
+			data-disabled={dataDisabled}
+			onkeydown
+			onkeydown={handleItemKey}
+			onclick
+			onfocus={() => handleItemFocus(index)}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/NavMenu/NavMenuGroup.torp

@@ -0,0 +1,30 @@
+import { NavMenuGroupContextName, type NavMenuGroupContext } from "./NavMenuTypes";
+
+/**
+ * A container for a logical group of navigation menu items.
+ *
+ * @prop {string | undefined} ariaLabel -- An ARIA label for describing the group to screen readers 
+ */
+export default function NavMenuGroup($props: any) {
+	let $state = $watch({
+		headerId: ""
+	});
+
+	// Set the context to pass down to items
+	let context: NavMenuGroupContext = {
+		state: $state,
+	};
+	$context[NavMenuGroupContextName] = context;
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-nav-menu-group ${$props.class ?? ""}`.trim()}
+			role="group"
+			aria-label={$props.ariaLabel}
+			aria-labelledby={$state.headerId}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/NavMenu/NavMenuGroupHeader.torp

@@ -0,0 +1,30 @@
+import getId from "../utils/getId";
+import { NavMenuGroupContextName, type NavMenuGroupContext } from "./NavMenuTypes";
+
+/**
+ * The header for a NavMenuGroup.
+ *
+ * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
+ */
+export default function NavMenuGroupHeader($props: any) {
+	$props.id ??= getId();
+
+	const context = $context[NavMenuGroupContextName] as NavMenuGroupContext;
+	if (!context) {
+		throw new Error("NavMenuGroupHeader must be contained within an NavMenuGroup");
+	}
+	let $state = context.state;
+
+	// Set the header ID now that we know what it is
+	$state.headerId = $props.id;
+
+	@render {
+		<h4
+			@// TODO: self={$props.as}
+			id={$props.id}
+			class={`torp-nav-menu-group-header ${$props.class ?? ""}`.trim()}
+		>
+			<:slot />
+		</h4>
+	}
+}

package/src/NavMenu/NavMenuLink.torp

@@ -0,0 +1,52 @@
+
+import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
+
+/**
+ * A link that is placed in a NavMenu and signals a response by a user.
+ *
+ * @prop {string} href -- The URL for the menu link
+ * @prop {newWindow} boolean -- Whether the menu link should open in a new tab/window
+ * @prop {boolean} disabled -- Whether this link is disabled
+ */
+export default function NavMenuLink($props: any) {
+	$props.newWindow ??= false;
+
+	/** Set when the item is disabled */
+	let dataDisabled = $props.disabled || undefined;
+
+	let link: HTMLAnchorElement;
+
+	// Get stuff out of the NavMenuContext
+	const menuContext = $context[NavMenuContextName] as NavMenuContext;
+	if (!menuContext) {
+		throw new Error("NavMenuLink must be contained within a NavMenu");
+	}
+	const { registerItem, handleItemKey, handleItemFocus } = menuContext;
+
+	// Register this item with the parent NavMenu and store the index
+	const { index } = registerItem(setFocused);
+
+	function setFocused() {
+		link.focus();
+	}
+
+	@render {
+		<a
+			id={$props.id}
+			class={`torp-nav-menu-link ${$props.class ?? ""}`.trim()}
+			href={$props.href}
+			disabled={$props.disabled}
+			target={$props.newWindow ? "_blank" : undefined}
+			role="menuitem"
+			aria-disabled={$props.disabled ? "true" : undefined}
+			data-disabled={dataDisabled}
+			onkeydown
+			onkeydown={handleItemKey}
+			onclick
+			onfocus={() => handleItemFocus(index)}
+			&ref={link}
+		>
+			<:slot />
+		</a>
+	}
+}

package/src/NavMenu/NavMenuPopout.torp

@@ -0,0 +1,69 @@
+import { NavMenuPopoutContextName, type NavMenuPopoutContext } from "./NavMenuTypes";
+
+/**
+ * A popout that is attached to a menu button and can be used to show a submenu.
+ *
+ * The structure of a NavMenuPopout is:
+ *
+ * ```
+ * <NavMenuPopout>
+ *     <NavMenuPopoutButton />
+ * 	<NavMenuPopoutContent />
+ * </NavMenuPopout>
+ * ```
+ *
+ * @prop {boolean} visible -- Whether the popout is visible
+ */
+export default function NavMenuPopout($props: any) {
+	$props.visible ??= false;
+
+	let $state = $watch({
+		visible: $props.visible
+	});
+
+	let result: any;
+
+	// Set the context to pass down to items
+	let context: NavMenuPopoutContext = {
+		state: $state,
+	};
+	$context[NavMenuPopoutContextName] = context;
+
+	// Copy props into state whenever they change
+	$run(() => {
+		$state.visible = $props.visible ?? false;
+	});
+
+	// Dispatch the toggle event when the popout is opened or closed
+	let firstToggle = true;
+	$run(() => {
+		const ontoggle = $props.ontoggle;
+		const onopen = $props.onopen;
+		const onclose = $props.onclose;
+		const visible = $props.visible;
+		if (firstToggle) {
+			firstToggle = false;
+		} else {
+			if (ontoggle) ontoggle(visible);
+			if (visible) {
+				if (onopen) onopen()
+			} else {
+				if (onclose) onclose(result);
+			}
+		}
+	});
+
+	function handleMouseLeave() {
+		$state.visible = false;
+	}
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-nav-menu-popout ${$props.class ?? ""}`.trim()}
+			onmouseleave={handleMouseLeave}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/NavMenu/NavMenuPopoutButton.torp

@@ -0,0 +1,120 @@
+
+import {
+	NavMenuContextName,
+	NavMenuPopoutContextName,
+	type NavMenuContext,
+	type NavMenuPopoutContext,
+} from "./NavMenuTypes";
+
+/**
+ * A button that is placed in a NavMenu 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 NavMenuPopoutButton($props: any) {
+	$props.hoverDelay ??= 500;
+
+	/** Set when the item is disabled */
+	let dataDisabled = $props.disabled || undefined;
+
+	let button: HTMLButtonElement;
+	let interval: NodeJS.Timeout | undefined;
+
+	// Get stuff out of the NavMenuContext
+	const menuContext = $context[NavMenuContextName] as NavMenuContext;
+	if (!menuContext) {
+		throw new Error("NavMenuPopoutButton must be contained within a NavMenu");
+	}
+	const { registerItem, handleItemKey, handleItemFocus } = menuContext;
+
+	// Get stuff out of the NavMenuPopoutContext
+	const popoutContext = $context[NavMenuPopoutContextName] as NavMenuPopoutContext;
+	if (!popoutContext) {
+		throw new Error("NavMenuPopoutButton must be contained within a NavMenuPopout");
+	}
+	let $state = popoutContext.state;
+
+	// Register this item with the parent NavMenu and store the index
+	const { index } = registerItem(setFocused);
+
+	// TODO: $mount should be run AFTER the button has been set
+	//$mount(() => {
+	//	// Set the anchor element to the button when it exists
+	//	popoutContext.anchorElement = button;
+	//});
+
+	function setFocused() {
+		button.focus();
+	}
+
+	function handleClick() {
+		$state.visible = true;
+	}
+
+	function handlePopoutKey(e: KeyboardEvent) {
+		switch (e.key) {
+			case "Right":
+			case "ArrowRight":
+				// TODO: This should be based on what side the menu shows on
+				e.preventDefault();
+				$state.visible = true;
+				break;
+			default:
+				handleItemKey(e);
+		}
+	}
+
+	function handleMouseEnter() {
+		if ($props.disabled) return;
+
+		// Handle the hover after a delay
+		if (!interval) {
+			interval = setTimeout(() => $state.visible = true, $props.hoverDelay);
+		}
+	}
+
+	function handleMouseLeave() {
+		if ($props.disabled) return;
+
+		// Prevent short hovers or touches from firing the event
+		if (interval) {
+			clearTimeout(interval);
+			interval = undefined;
+		}
+	}
+
+	function handleMouseMove() {
+		if ($props.disabled) return;
+
+		// Reset the interval on mouse move
+		if (interval) {
+			clearTimeout(interval);
+			interval = setTimeout(() => $state.visible = true, $props.hoverDelay);
+		}
+	}
+
+	@render {
+		<button
+			id={$props.id}
+			class={`torp-nav-menu-popout-button ${$props.class ?? ""}`.trim()}
+			type="button"
+			disabled={$props.disabled}
+			role="menuitem"
+			aria-haspopup="true"
+			aria-expanded={$state.visible.toString()}
+			aria-disabled={$props.disabled ? "true" : undefined}
+			data-disabled={dataDisabled}
+			onkeydown={handlePopoutKey}
+			onclick={handleClick}
+			onfocus={() => handleItemFocus(index)}
+			onmouseenter={handleMouseEnter}
+			onmouseleave={handleMouseLeave}
+			onmousemove={handleMouseMove}
+			&ref={button}
+			:onmount={(el) => popoutContext.anchorElement = el }
+		>
+			<:slot />
+		</button>
+	}
+}

package/src/NavMenu/NavMenuPopoutContent.torp

@@ -0,0 +1,79 @@
+
+import getScrollParent from "../utils/getScrollParent";
+import setPopoverPosition from "../utils/setPopoverPosition";
+import { NavMenuPopoutContextName, type NavMenuPopoutContext } from "./NavMenuTypes";
+
+/**
+ * The content that is displayed for a NavMenuPopout 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 NavMenuPopoutContent($props: any) {
+	$props.side ??= "bottom";
+	$props.alignment ??= "start";
+
+	let div: HTMLDivElement;
+
+	// Get stuff out of the NavMenuPopoutContext
+	const context = $context[NavMenuPopoutContextName] as NavMenuPopoutContext;
+	if (!context) {
+		throw new Error("NavMenuPopoutContent must be contained within a NavMenuPopout");
+	}
+	let $state = context.state;
+
+	let first = true;
+	$run(() => {
+		let visible = $state.visible;
+
+		if (first) {
+			first = false;
+			return;
+		}
+
+		if (visible) {
+			// Wait for the content div to be shown, set its position, and listen for window resize to re-position
+			//await tick();
+			setPosition();
+			if (context.focusFirstElement) {
+				context.focusFirstElement();
+			}
+			const scrollParent = getScrollParent(context.anchorElement)
+			scrollParent.addEventListener("resize", setPosition);
+			scrollParent.addEventListener("scroll", setPosition);
+		} else {
+			// Stop listening for window resize and focus the anchor element per WAI guidelines
+			const scrollParent = getScrollParent(context.anchorElement)
+			scrollParent.removeEventListener("resize", setPosition);
+			scrollParent.removeEventListener("scroll", setPosition);
+			if (context.anchorElement?.focus) {
+				context.anchorElement.focus();
+			}
+		}
+	});
+
+	function setPosition() {
+		if (!context.anchorElement) {
+			throw new Error("NavMenuPopoutContent must have an anchor element");
+		}
+
+		if (div) {
+			setPopoverPosition(context.anchorElement, div, $props.side, $props.alignment);
+		}
+	}
+
+	@render {
+		<div style="display: contents">			
+			@if ($state.visible) {
+				<div
+					id={$props.id}
+					class={`torp-nav-menu-popout-content ${$props.class ?? ""}`.trim()}
+					&ref={div}
+					:onmount={(el) => setPopoverPosition(context.anchorElement, el, $props.side, $props.alignment)}
+				>
+					<:slot />
+				</div>
+			}
+		</div>
+	}
+}

package/src/NavMenu/NavMenuSeparator.torp

@@ -0,0 +1,14 @@
+
+/**
+ * An element in a menu that separates logical sets of menu items.
+ */
+export default function NavMenuSeparator($props: any) {
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-nav-menu-separator ${$props.class ?? ""}`.trim()} role="separator"
+		>
+			<:slot />
+		</div>
+	}
+}