@torpor/ui 0.0.17 → 0.1.0

package/src/NavMenu/NavMenuTypes.ts

@@ -0,0 +1,32 @@
+export const NavMenuContextName = "NavMenu";
+export const NavMenuPopoutContextName = "NavMenuPopout";
+export const NavMenuGroupContextName = "NavMenuGroup";
+
+export interface NavMenuContext {
+	/** Called from a NavMenuLink or NavMenuButton when its button is focused */
+	handleItemFocus: (index: number) => void;
+
+	/** Called from a NavMenuLink or NavMenuButton when a key is pressed */
+	handleItemKey: (e: KeyboardEvent) => void;
+
+	/** Called from each NavMenuLink or NavMenuButton to register itself with this NavMenu */
+	registerItem: (setFocused: () => void) => { index: number };
+}
+
+export interface NavMenuPopoutContext {
+	state: {
+		visible: boolean;
+	};
+	anchorElement?: HTMLElement;
+	focusFirstElement?: () => void;
+}
+
+export interface NavMenuGroupContext {
+	state: {
+		headerId: string;
+	};
+}
+
+export interface ItemState {
+	setFocused: () => void;
+}

package/src/NavMenu/index.ts

@@ -0,0 +1,23 @@
+import NavMenu from "./NavMenu.torp";
+import NavMenuButton from "./NavMenuButton.torp";
+import NavMenuElement from "./NavMenuElement.torp";
+import NavMenuGroup from "./NavMenuGroup.torp";
+import NavMenuGroupHeader from "./NavMenuGroupHeader.torp";
+import NavMenuLink from "./NavMenuLink.torp";
+import NavMenuPopout from "./NavMenuPopout.torp";
+import NavMenuPopoutButton from "./NavMenuPopoutButton.torp";
+import NavMenuPopoutContent from "./NavMenuPopoutContent.torp";
+import NavMenuSeparator from "./NavMenuSeparator.torp";
+
+export {
+	NavMenu,
+	NavMenuLink,
+	NavMenuButton,
+	NavMenuElement,
+	NavMenuPopout,
+	NavMenuPopoutButton,
+	NavMenuPopoutContent,
+	NavMenuGroup,
+	NavMenuGroupHeader,
+	NavMenuSeparator,
+};

package/src/NavMenu.ts

@@ -0,0 +1,23 @@
+import NavMenu from "./NavMenu/NavMenu.torp";
+import NavMenuButton from "./NavMenu/NavMenuButton.torp";
+import NavMenuElement from "./NavMenu/NavMenuElement.torp";
+import NavMenuGroup from "./NavMenu/NavMenuGroup.torp";
+import NavMenuGroupHeader from "./NavMenu/NavMenuGroupHeader.torp";
+import NavMenuLink from "./NavMenu/NavMenuLink.torp";
+import NavMenuPopout from "./NavMenu/NavMenuPopout.torp";
+import NavMenuPopoutButton from "./NavMenu/NavMenuPopoutButton.torp";
+import NavMenuPopoutContent from "./NavMenu/NavMenuPopoutContent.torp";
+import NavMenuSeparator from "./NavMenu/NavMenuSeparator.torp";
+
+export {
+	NavMenu,
+	NavMenuLink,
+	NavMenuButton,
+	NavMenuElement,
+	NavMenuPopout,
+	NavMenuPopoutButton,
+	NavMenuPopoutContent,
+	NavMenuGroup,
+	NavMenuGroupHeader,
+	NavMenuSeparator,
+};

package/src/Popover/Popover.torp

@@ -0,0 +1,105 @@
+import { PopoverContextName, type Point, type PopoverContext, type PopoverState } from "./PopoverTypes";
+
+/**
+ * A popover 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 Popover is:
+ *
+ * ```
+ * <Popover>
+ * 	<PopoverOverlay /> (optional, if modal)
+ * 	<PopoverTrigger/PopoverTriggerContextual/PopoverTriggerHover /> (optional)
+ * 	<PopoverContentStatic/PopoverContentAnchored/PopoverContentContextual />
+ * </Popover>
+ * ```
+ * @prop {boolean} modal -- Whether the popover is modal. If true, an overlay should be supplied to obscure outside content, and only the popover content will be visible to screen readers 
+ * @prop {boolean} visible -- Whether the popover is visible 
+ * @prop {HTMLElement | undefined} anchor -- The element to anchor this popover to, as an alternative to supplying a PopoverTrigger 
+ * @prop {Point | undefined} position -- The position to display this popover at if it's contextual, as an alternative to supplying a PopoverTriggerContextual 
+ * @prop {((value: any) => void) | undefined} [callback] -- A function to be called when the user selects a response
+ */
+export default function Popover($props: any) {
+	let $state: PopoverState = $watch({
+		visible: false,
+		position: { x: 0, y: 0 }
+	})
+
+	let result: any;
+
+	// Set the context to pass down to items
+	let context: PopoverContext = {
+		handleButton,
+		handleClickOutside,
+		state: $state,
+		modal: $props.modal,
+		anchorElement: $unwrap($props.anchor),
+	};
+	$context[PopoverContextName] = context;
+
+	// Copy props into state whenever they change
+	$run(() => {
+		$state.visible = $props.visible ?? false;
+		$state.position = $props.position ?? { x: 0, y: 0 };
+	})
+
+	// 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 = $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 popover
+		$state.visible = false;
+
+		// Call the callback
+		if ($props.callback) {
+			$props.callback(result);
+		}
+	}
+
+	function handleClickOutside(e: MouseEvent) {
+		e.preventDefault();
+		$state.visible = false;
+	}
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-popover ${$props.class ?? ""}`.trim()}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/Popover/PopoverContentAnchored.torp

@@ -0,0 +1,107 @@
+import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import getScrollParent from "../utils/getScrollParent";
+import setPopoverPosition from "../utils/setPopoverPosition";
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The content that is displayed for a Popover when it is open, displayed
+ * alongside an element.
+ *
+ * @prop {"top" | "right" | "bottom" | "left"} site -- Where the popover will be
+ * shown, relative to the popover button
+ * @prop {"start" | "center" | "end"} alignment -- How the popover will be
+ * aligned, relative to the popover button
+ */
+export default function PopoverContentAnchored($props: any) {
+	$props.side ??= "bottom";
+	$props.alignment ??= "center";
+
+	let div: HTMLDivElement;
+
+	let closeOnClick = false;
+
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverContentAnchored must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	let first = true;
+	$run(() => {
+		let visible = $state.visible;
+
+		if (first) {
+			first = false;
+			return;
+		}
+
+		if (visible) {
+			// HACK: Because this Popover could be shown with a click, we need to wait for another mousedown
+			// before we close on click. Otherwise the click immediately bubbles to the document
+			closeOnClick = false;
+			addDocumentEvent("mousedown", handleDocumentMouseDown);
+			addDocumentEvent("click", handleDocumentClick);
+			// 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 {
+			removeDocumentEvent("mousedown", handleDocumentMouseDown);
+			removeDocumentEvent("click", handleDocumentClick);
+			// 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 handleDocumentMouseDown() {
+		closeOnClick = true;
+	}
+
+	function handleDocumentClick(e: MouseEvent) {
+		if (
+			closeOnClick &&
+			div &&
+			!div.contains(e.target as HTMLElement) &&
+			(!context.anchorElement || !context.anchorElement.contains(e.target as HTMLElement))
+		) {
+			e.preventDefault();
+			context.handleClickOutside!(e);
+		}
+	}
+
+	function setPosition() {
+		if (!context.anchorElement) {
+			throw new Error("PopoverContentAnchored must have an anchor element");
+		}
+
+		if (div) {
+			setPopoverPosition(context.anchorElement, div, $props.side, $props.alignment);
+		}
+	}
+
+	@render {
+		<div style="display: content;">
+			@if ($state.visible) {
+				<div
+					id={$props.id}
+					class={`torp-popover-content-anchored ${$props.class ?? ""}`.trim()}
+					&ref={div}
+					:onmount={(el) => setPopoverPosition(context.anchorElement, el, $props.side, $props.alignment)}
+				>
+					<:slot />
+				</div>
+			}
+		</div>
+	}
+}

package/src/Popover/PopoverContentContextual.torp

@@ -0,0 +1,99 @@
+
+import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import getScrollParent from "../utils/getScrollParent";
+import setContextPosition from "../utils/setContextPosition";
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The content that is displayed for a Popover when it is open, displayed at the
+ * position that the user right-clicked.
+ */
+export default function PopoverContentContextual($props: any) {	
+	let div: HTMLDivElement;
+
+	let closeOnClick = false;
+
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("ContextualContent must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	let first = true;
+	$run(() => {
+		let visible = $state.visible;
+
+		if (first) {
+			first = false;
+			return;
+		}
+
+		if (visible) {
+			// HACK: Because this Contextual could be shown with a click, we need to wait for another mousedown
+			// before we close on click. Otherwise the click immediately bubbles to the document
+			closeOnClick = false;
+			addDocumentEvent("mousedown", handleDocumentMouseDown);
+			addDocumentEvent("click", handleDocumentClick);
+			// 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 {
+			removeDocumentEvent("mousedown", handleDocumentMouseDown);
+			removeDocumentEvent("click", handleDocumentClick);
+			// 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 handleDocumentMouseDown() {
+		closeOnClick = true;
+	}
+
+	function handleDocumentClick(e: MouseEvent) {
+		if (
+			closeOnClick &&
+			div &&
+			!div.contains(e.target as HTMLElement) &&
+			(!context.anchorElement || !context.anchorElement.contains(e.target as HTMLElement))
+		) {
+			context.handleClickOutside!(e);
+		}
+	}
+
+	function setPosition() {
+		if (!context.anchorElement) {
+			throw new Error("ContextualContent must have an anchor element");
+		}
+
+		if (div && $state.position) {
+			setContextPosition(context.anchorElement, div, $state.position);
+		}
+	}
+
+	@render {
+		<div style="display: content;">
+			@if ($state.visible) {
+				<div
+					id={$props.id}
+					class={`torp-popover-content-contextual ${$props.class ?? ""}`.trim()}
+					&ref={div}
+					:onmount={(el) => setContextPosition(context.anchorElement, el, $state.position)}
+				>
+					<:slot />
+				</div>
+			}
+		</div>
+	}
+}

package/src/Popover/PopoverContentStatic.torp

@@ -0,0 +1,78 @@
+import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The content that is displayed for a Popover when it is open, such as a Dialog
+ * in the middle of the screen or a div that slides in from the side.
+ */
+export default function PopoverContentStatic($props: any) {
+	let div: HTMLDivElement;
+
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverContentStatic must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	let closeOnClick = false;
+
+	let first = true;
+	$run(() => {
+		let visible = $state.visible;
+
+		if (first) {
+			first = false;
+			return;
+		}
+
+		if (visible) {
+			// HACK: Because this Popover could be shown with a click, we need to wait for another mousedown
+			// before we close on click. Otherwise the click immediately bubbles to the document
+			closeOnClick = false;
+			addDocumentEvent("mousedown", handleDocumentMouseDown);
+			addDocumentEvent("click", handleDocumentClick);
+			// Wait for the content div to be shown, set its position, and listen for window resize to re-position
+			//await tick();
+			if (context.focusFirstElement) {
+				context.focusFirstElement();
+			}
+		} else {
+			removeDocumentEvent("mousedown", handleDocumentMouseDown);
+			removeDocumentEvent("click", handleDocumentClick);
+			// Focus the anchor element per WAI guidelines
+			if (context.anchorElement?.focus) {
+				context.anchorElement.focus();
+			}
+		}
+	});
+
+	function handleDocumentMouseDown() {
+		closeOnClick = true;
+	}
+
+	function handleDocumentClick(e: MouseEvent) {
+		if (
+			closeOnClick &&
+			div &&
+			!div.contains(e.target as HTMLElement) &&
+			(!context.anchorElement || !context.anchorElement.contains(e.target as HTMLElement))
+		) {
+			context.handleClickOutside!(e);
+		}
+	}
+
+	@render {
+		<div style="display: content;">
+			@if ($state.visible) {
+				<div
+					id={$props.id}
+					class={`torp-popover-content-static ${$props.class ?? ""}`.trim()}
+					&ref={div}
+				>
+					<:slot />
+				</div>
+			}
+		</div>
+	}
+}

package/src/Popover/PopoverOverlay.torp

@@ -0,0 +1,32 @@
+import { disableScroll } from "../mount/disableScroll";
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The background overlay for a Popover. Adding an overlay automatically sets the Popover to modal.
+ */
+export default function PopoverOverlay($props: any) {
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverOverlay must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	// Any Popover with an overlay is modal
+	context.modal = true;
+
+	@render {
+		<div style="display: content;">
+			@if ($state.visible) {
+				<div
+					id={$props.id}
+					class={`torp-popover-overlay ${$props.class ?? ""}`.trim()}
+					tabindex="-1"
+					:onmount={(el) => disableScroll(el)}
+				>
+					<:slot />
+				</div>
+			}
+		</div>
+	}
+}

package/src/Popover/PopoverTrigger.torp

@@ -0,0 +1,29 @@
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The button that causes a Popover to appear or disappear.
+ */
+export default function PopoverTrigger($props: any) {
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverTrigger must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	function handleClick() {
+		$state.visible = !$state.visible;
+	}
+
+	@render {
+		<button
+			type="button"
+			id={$props.id}
+			class={`torp-popover-trigger ${$props.class ?? ""}`.trim()}
+			onclick={handleClick}
+			&ref={context.anchorElement}
+		>
+			<:slot />
+		</button>
+	}
+}

package/src/Popover/PopoverTriggerContextual.torp

@@ -0,0 +1,37 @@
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+
+/**
+ * The element that causes a Popover to appear or disappear when right-clicked.
+ */
+export default function PopoverTriggerContextual($props: any) {
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverTriggerContextual must be contained within a Contextual");
+	}
+	let $state = context.state;
+
+	function handleContextual(e: MouseEvent & { currentTarget: EventTarget & HTMLDivElement }) {
+		e.preventDefault();
+		if ($state.position) {
+			// Get the position relative to the element, so we can reposition on scroll
+			const rect = e.currentTarget.getBoundingClientRect();
+			const x = e.clientX - rect.left;
+			const y = e.clientY - rect.top;
+			$state.position = { x, y };
+			//$state.position = { x: window.scrollX + e.clientX, y: window.scrollY + e.clientY };
+		}
+		$state.visible = !$state.visible;
+	}
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-popover-trigger-contextual ${$props.class ?? ""}`.trim()}
+			oncontextmenu={handleContextual}
+			&ref={context.anchorElement}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/Popover/PopoverTriggerHover.torp

@@ -0,0 +1,30 @@
+
+import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+import hoverTrigger from "../mount/hoverTrigger";
+
+/**
+ * The div that causes a Popover to appear or disappear when hovered.
+ */
+export default function PopoverTriggerHover($props: any) {
+	// Get stuff out of the PopoverContext
+	const context = $context[PopoverContextName] as PopoverContext;
+	if (!context) {
+		throw new Error("PopoverTriggerHover must be contained within a Popover");
+	}
+	let $state = context.state;
+
+	function handleHover() {
+		$state.visible = !$state.visible
+	}
+
+	@render {
+		<div
+			id={$props.id}
+			class={`torp-popover-trigger-hover ${$props.class ?? ""}`.trim()}
+			:onmount={(el) => hoverTrigger(el, { onHover: handleHover, onExit: handleHover })}
+			&ref={context.anchorElement}
+		>
+			<:slot />
+		</div>
+	}
+}

package/src/Popover/PopoverTypes.ts

@@ -0,0 +1,30 @@
+export const PopoverContextName = "Popover";
+
+/** The shared context for popover components (Contextual, Prompt and Popover) */
+export interface PopoverContext {
+	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: PopoverState;
+	modal: boolean;
+	anchorElement?: HTMLElement;
+	// 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 PopoverState {
+	visible: boolean;
+	position: Point;
+}
+
+export interface Point {
+	x: number;
+	y: number;
+}

package/src/Popover/index.ts

@@ -0,0 +1,29 @@
+import Popover from "./Popover.torp";
+import PopoverContentAnchored from "./PopoverContentAnchored.torp";
+import PopoverContentContextual from "./PopoverContentContextual.torp";
+import PopoverContentStatic from "./PopoverContentStatic.torp";
+import PopoverOverlay from "./PopoverOverlay.torp";
+import PopoverTrigger from "./PopoverTrigger.torp";
+import PopoverTriggerContextual from "./PopoverTriggerContextual.torp";
+import PopoverTriggerHover from "./PopoverTriggerHover.torp";
+import clickPopover from "./mountClickPopover";
+import contextPopover from "./mountContextPopover";
+import hoverPopover from "./mountHoverPopover";
+import showPopover from "./showPopover";
+import showPopoverPrompt from "./showPopoverPrompt";
+
+export {
+	Popover,
+	PopoverOverlay,
+	PopoverTrigger,
+	PopoverTriggerHover,
+	PopoverTriggerContextual,
+	PopoverContentAnchored,
+	PopoverContentContextual,
+	PopoverContentStatic,
+	showPopover,
+	showPopoverPrompt,
+	clickPopover,
+	contextPopover,
+	hoverPopover,
+};