@torpor/ui 0.0.17 → 0.1.0

package/src/Popover/mountClickPopover.ts

@@ -0,0 +1,50 @@
+import type { Component } from "@torpor/view";
+import showPopover from "./showPopover";
+
+interface ClickPopoverOptions {
+	popover: Component;
+	props?: Record<PropertyKey, any>;
+}
+
+/**
+ * A mount directive for showing a popover when an element is clicked.
+ * @param node The element to show the popover for
+ * @param options Options for showing the popover, consisting of the popover component and any props
+ */
+export default function clickPopover(node: HTMLElement, options: ClickPopoverOptions) {
+	const { popover, props } = options;
+
+	// Add a click event handler to the node
+	node.addEventListener("click", handleClick);
+
+	function handleClick(e: MouseEvent) {
+		e.preventDefault();
+		show();
+	}
+
+	let div: HTMLDivElement;
+
+	function show() {
+		// Show the popover in a div
+		if (div) {
+			document.body.removeChild(div);
+		}
+		div = document.createElement("div");
+		document.body.appendChild(div);
+
+		showPopover(popover, node, props, div);
+	}
+
+	return {
+		destroy(): void {
+			// Remove the event listener from the node on destroy
+			node.removeEventListener("click", handleClick);
+
+			// Remove the div we added
+			// TODO: Should we do this in more places?
+			if (div) {
+				document.body.removeChild(div);
+			}
+		},
+	};
+}

package/src/Popover/mountContextPopover.ts

@@ -0,0 +1,50 @@
+import type { Component } from "@torpor/view";
+import showPopover from "./showPopover";
+
+interface ContextPopoverOptions {
+	popover: Component;
+	props?: Record<PropertyKey, any>;
+}
+
+/**
+ * A mount directive for showing a popover when the user opens an element's context menu.
+ * @param node The element to show the popover for
+ * @param options Options for showing the popover, consisting of the popover component and any props
+ */
+export default function contextPopover(node: HTMLElement, options: ContextPopoverOptions) {
+	const { popover, props } = options;
+
+	// Add a contextmenu event handler to the node
+	node.addEventListener("contextmenu", handleClick);
+
+	function handleClick(e: MouseEvent) {
+		e.preventDefault();
+		show();
+	}
+
+	let div: HTMLDivElement;
+
+	function show() {
+		// Show the popover in a div
+		if (div) {
+			document.body.removeChild(div);
+		}
+		div = document.createElement("div");
+		document.body.appendChild(div);
+
+		showPopover(popover, node, props, div);
+	}
+
+	return {
+		destroy(): void {
+			// Remove the event listener from the node on destroy
+			node.removeEventListener("contextmenu", handleClick);
+
+			// Remove the div we added
+			// TODO: Should we do this in more places?
+			if (div) {
+				document.body.removeChild(div);
+			}
+		},
+	};
+}

package/src/Popover/mountHoverPopover.ts

@@ -0,0 +1,57 @@
+import type { Component } from "@torpor/view";
+import hoverTrigger from "../mount/hoverTrigger";
+import showPopover from "./showPopover";
+
+interface HoverPopoverOptions {
+	popover: Component;
+	props?: Record<PropertyKey, any>;
+	hoverDelay?: number;
+	touchDelay?: number;
+}
+
+/**
+ * A mount directive for showing a popover when an element is hovered.
+ * @param node The element to show the popover for
+ * @param options Options for showing the popover, consisting of the popover component, any props and delays for hover and touch
+ */
+export default function hoverPopover(node: HTMLElement, options: HoverPopoverOptions): () => void {
+	const { popover, props, hoverDelay, touchDelay } = options;
+
+	let div: HTMLDivElement | undefined;
+
+	function onHover(node: HTMLElement, e: MouseEvent | TouchEvent) {
+		// Show the popover in a div
+		if (div) {
+			document.body.removeChild(div);
+		}
+		div = document.createElement("div");
+		document.body.appendChild(div);
+
+		// Get the position relative to the element, so we can reposition on scroll
+		const rect = node.getBoundingClientRect();
+		let position: { x: number; y: number };
+		if (e.type.startsWith("mouse")) {
+			const me = e as MouseEvent;
+			position = { x: me.clientX - rect.left, y: me.clientY - rect.top };
+		} else {
+			const te = e as TouchEvent;
+			position = {
+				x: te.touches[0].clientX - rect.left,
+				y: te.touches[0].clientY - rect.top,
+			};
+		}
+		const allProps = Object.assign({}, props, { anchor: node, position });
+
+		showPopover(popover, node, allProps, div);
+	}
+
+	function onExit() {
+		// Remove the div
+		if (div) {
+			document.body.removeChild(div);
+			div = undefined;
+		}
+	}
+
+	return hoverTrigger(node, { onHover, onExit, hoverDelay, touchDelay });
+}

package/src/Popover/showPopover.ts

@@ -0,0 +1,24 @@
+// TODO: Allow passing in a variable -- so that you can show an inline popover
+import type { Component } from "@torpor/view";
+
+/**
+ * Shows a popover component in code.
+ * @param popover The popover component
+ * @param anchor The element to use as an anchor for the popover component
+ * @param props The properties for the popover component
+ * @param target The target element to show the popover in
+ * @returns The value selected by the user
+ */
+export default function showPopover(
+	popover: Component,
+	anchor: HTMLElement,
+	props?: Record<PropertyKey, any>,
+	target?: Element,
+): void {
+	// Add the anchor element to the properties
+	const allProps = Object.assign({}, props, { anchor });
+
+	// Create the popover
+	// TODO: This needs to clean up after itself, like the mount methods do
+	popover(target || anchor.parentElement || document.body, null, allProps);
+}

package/src/Popover/showPopoverPrompt.ts

@@ -0,0 +1,23 @@
+import type { Component } from "@torpor/view";
+
+/**
+ * Shows a popover component in code, and asynchronously returns the value selected by the user.
+ * @param popover The popover component
+ * @param props The properties for the popover component
+ * @param target The target element to show the popover in
+ * @returns The value selected by the user
+ */
+export default function showPopoverPrompt(
+	popover: Component,
+	props?: Record<PropertyKey, any>,
+	target?: Element,
+): Promise<void> {
+	return new Promise((resolve) => {
+		// Add the promise as the callback
+		const allProps = Object.assign({}, props, { callback: resolve });
+
+		// Create the popover
+		// TODO: This needs to clean up after itself, like the use methods do
+		popover(target || document.body, null, allProps);
+	});
+}

package/src/Popover.ts

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

package/src/TabGroup/TabContent.torp

@@ -1,5 +1,5 @@
-import getId from '../utils/getId';
-import { TabGroupContextName, type TabGroupContext } from './TabGroupTypes';
+import getId from "../utils/getId";
+import { TabGroupContextName, type TabGroupContext } from "./TabGroupTypes";
 
 /**
  * Content for a TabGroup, which can be revealed or hidden by an associated TabTrigger.
@@ -11,7 +11,7 @@ export default function TabContent($props: any) {
 
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
-		throw new Error('TabContent must be contained within a TabGroup');
+		throw new Error("TabContent must be contained within a TabGroup");
 	}
 	let $state = $context[TabGroupContextName].registerItem($props.index, $props.value);
 
@@ -21,7 +21,7 @@ export default function TabContent($props: any) {
 	@render {
 		<div
 			id={$props.id}
-			class='torp-tab-content'
+			class={`torp-tab-content ${$props.class ?? ""}`.trim()}
 			role="tabpanel"
 			aria-labelledby={$state.headerId}
 			data-orientation={$props.orientation}

package/src/TabGroup/TabGroup.torp

@@ -1,4 +1,4 @@
-import { TabGroupContextName, type TabGroupContext, type ItemState } from './TabGroupTypes';
+import { TabGroupContextName, type TabGroupContext, type ItemState } from "./TabGroupTypes";
 
 /**
  * A list of interactive headings coupled with layered sections of content that
@@ -19,26 +19,18 @@ import { TabGroupContextName, type TabGroupContext, type ItemState } from './Tab
  * </TabGroup>
  * ```
  *
- * @prop {'horizontal' | 'vertical'} orientation -- The orientation of the tab buttons, which affects keyboard navigation
- * @prop {'automatic' | 'manual'} activation -- How tabs are activated; if automatic they are shown on focus, if manual they must be clicked
+ * @prop {"horizontal" | "vertical"} orientation -- The orientation of the tab buttons, which affects keyboard navigation
+ * @prop {"automatic" | "manual"} activation -- How tabs are activated; if automatic they are shown on focus, if manual they must be clicked
  * @prop {string | string[]} value -- The value of the active TabContent
  * @prop {boolean} disabled -- If set to true, the user cannot interact with any items in the TabGroup
  * @prop {(value: string | string[]) => void} [onchange] -- Raised when the active item has changed
  */
 export default function TabGroup($props: any) {
-	$props.orientation ||= 'horizontal';
-	$props.activation ||= 'automatic';
-	$props.value ||= '';
+	$props.orientation ||= "horizontal";
+	$props.activation ||= "automatic";
+	$props.value ||= "";
 
-	interface State {
-		value: string;
-		itemStates: ItemState[];
-	}
-
-	let $state: State = $watch({
-		value: $props.value,
-		itemStates: []
-	})
+	let itemStates: ItemState[] = [];
 
 	// This is used to assign automatic indexes to items where needed
 	let nextHeaderIndex = 0;
@@ -55,37 +47,40 @@ export default function TabGroup($props: any) {
 		activation: $props.activation,
 	};
 	$context[TabGroupContextName] = context;
-
 	$run(() => {
 		// HACK: This should probably be done with setters?
-		let newValue = $state.value;
+		let newValue = $props.value;
 
 		// Ensure the value passed in was a string (in case e.g. the user has set values to ints)
 		newValue = newValue?.toString();
-		for (let item of $state.itemStates) {
+		for (let item of itemStates) {
 			item.active = item.value === newValue;
 		}
 
 		// Set the value
-		$state.value = newValue;
+		$props.value = newValue;
 	});
 
 	$run(() => {
-		$state.itemStates.forEach((s) => s.parentDisabled = $props.disabled);
+		itemStates.forEach((s) => s.parentDisabled = $props.disabled);
 	});
 
 	// Dispatch the change event when the value changes
-	// TODO: Should this be a setter instead?
+	let firstChange = true;
 	$run(() => {
-		if ($props.onchange) {
-			$props.onchange($state.value);
+		const ev = $props.onchange;
+		const value = $props.value;
+		if (firstChange) {
+			firstChange = false;
+		} else if (ev) {
+			ev(value);
 		}
-	})
+	});
 
 	// TODO:
 	//$mount(() => {
-	//	if ($state.value === "" && $state.itemStates.length) {
-	//		$state.value = $state.itemStates[0].value;
+	//	if ($props.value === "" && itemStates.length) {
+	//		$props.value = itemStates[0].value;
 	//	}
 	//})
 
@@ -117,8 +112,8 @@ export default function TabGroup($props: any) {
 
 	function getItemState(index: number, value: string | undefined): ItemState {
 		// If we already have an item at this index, just return it
-		if ($state.itemStates.length > index) {
-			return $state.itemStates[index];
+		if (itemStates.length > index) {
+			return itemStates[index];
 		}
 
 		// If a value wasn't set for the item, set it to the index
@@ -130,16 +125,19 @@ export default function TabGroup($props: any) {
 		const newItemState: ItemState = $watch({
 			index,
 			value,
-			active: value === $state.value,
-			headerId: '',
-			contentId: '',
+			active: value === $props.value,
+			headerId: "",
+			contentId: "",
 			disabled: false,
 			parentDisabled: false,
+			get dataState() {
+				return this.active ? "active" : "inactive";
+			},
 			setFocused: () => {},
 			orientation: $props.orientation,
 			activation: $props.activation
 		});
-		$state.itemStates.splice(index, 0, newItemState);
+		itemStates.splice(index, 0, newItemState);
 
 		return newItemState;
 	}
@@ -147,18 +145,18 @@ export default function TabGroup($props: any) {
 	// TODO: I think this should be done by value
 	function removeItem(itemIndex: number) {
 		// Remove the item and re-index
-		let index = $state.itemStates.findIndex((item) => item.index === itemIndex);
+		let index = itemStates.findIndex((item) => item.index === itemIndex);
 		if (index !== -1) {
-			$state.itemStates.splice(itemIndex, 1);
+			itemStates.splice(itemIndex, 1);
 		}
-		$state.itemStates.forEach((item, i) => (item.index = i));
+		itemStates.forEach((item, i) => (item.index = i));
 	}
 
 	function triggerItem(toggleValue: string) {
-		for (let item of $state.itemStates) {
+		for (let item of itemStates) {
 			// The item is active if it has the supplied value
 			if (item.value === toggleValue) {
-				$state.value = item.value;
+				$props.value = item.value;
 				break;
 			}
 		}
@@ -166,49 +164,49 @@ export default function TabGroup($props: any) {
 
 	function handleHeaderKey(headerIndex: number, e: KeyboardEvent) {
 		switch (e.key) {
-			case 'Left':
-			case 'ArrowLeft': {
-				if ($props.orientation === 'horizontal' && headerIndex > 0) {
+			case "Left":
+			case "ArrowLeft": {
+				if ($props.orientation === "horizontal" && headerIndex > 0) {
 					e.preventDefault();
-					$state.itemStates[headerIndex - 1].setFocused();
+					itemStates[headerIndex - 1].setFocused();
 				}
 				break;
 			}
-			case 'Up':
-			case 'ArrowUp': {
-				if ($props.orientation === 'vertical' && headerIndex > 0) {
+			case "Up":
+			case "ArrowUp": {
+				if ($props.orientation === "vertical" && headerIndex > 0) {
 					e.preventDefault();
-					$state.itemStates[headerIndex - 1].setFocused();
+					itemStates[headerIndex - 1].setFocused();
 				}
 				break;
 			}
-			case 'Right':
-			case 'ArrowRight': {
-				if ($props.orientation === 'horizontal' && headerIndex < $state.itemStates.length - 1) {
+			case "Right":
+			case "ArrowRight": {
+				if ($props.orientation === "horizontal" && headerIndex < itemStates.length - 1) {
 					e.preventDefault();
-					$state.itemStates[headerIndex + 1].setFocused();
+					itemStates[headerIndex + 1].setFocused();
 				}
 				break;
 			}
-			case 'Down':
-			case 'ArrowDown': {
-				if ($props.orientation === 'vertical' && headerIndex < $state.itemStates.length - 1) {
+			case "Down":
+			case "ArrowDown": {
+				if ($props.orientation === "vertical" && headerIndex < itemStates.length - 1) {
 					e.preventDefault();
-					$state.itemStates[headerIndex + 1].setFocused();
+					itemStates[headerIndex + 1].setFocused();
 				}
 				break;
 			}
-			case 'Home': {
+			case "Home": {
 				if (headerIndex > 0) {
 					e.preventDefault();
-					$state.itemStates[0].setFocused();
+					itemStates[0].setFocused();
 				}
 				break;
 			}
-			case 'End': {
-				if (headerIndex < $state.itemStates.length - 1) {
+			case "End": {
+				if (headerIndex < itemStates.length - 1) {
 					e.preventDefault();
-					$state.itemStates[$state.itemStates.length - 1].setFocused();
+					itemStates[itemStates.length - 1].setFocused();
 				}
 				break;
 			}
@@ -217,7 +215,8 @@ export default function TabGroup($props: any) {
 
 	@render {
 		<div
-			class="torp-tab-group"
+			id={$props.id}
+			class={`torp-tab-group ${$props.class ?? ""}`.trim()}
 			data-orientation={$props.orientation}
 		>
 			<:slot />

package/src/TabGroup/TabGroupTypes.ts

@@ -33,6 +33,7 @@ export interface ItemState {
 	contentId: string;
 	disabled: boolean;
 	parentDisabled: boolean;
+	dataState: "active" | "inactive";
 	/** Called in the TabGroup when a header needs to be focused */
 	setFocused: () => void;
 }

package/src/TabGroup/TabHeader.torp

@@ -1,9 +1,9 @@
-import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from './TabGroupTypes';
+import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from "./TabGroupTypes";
 
 /**
  * The header for a tab item, which contains the TabTrigger.
  *
- * The structure of an TabHeader is:
+ * The structure of a TabHeader is:
  * 
  * ```
  * <TabHeader>
@@ -11,12 +11,12 @@ import { TabGroupContextName, TabItemContextName, type TabGroupContext, type Tab
  * </TabHeader>
  * ```
  *
- * @prop {'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'} as -- The type of HTML header to use
+ * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
  */
 export default function TabHeader($props: any) {
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
-		throw new Error('TabHeader must be contained within a TabGroup');
+		throw new Error("TabHeader must be contained within a TabGroup");
 	}
 	let $state = $context[TabGroupContextName].registerHeader($props.index, $props.value);
 
@@ -37,10 +37,12 @@ export default function TabHeader($props: any) {
 	@render {
 		@// TODO: $props.as
 		<h4
-			:class={{
-				'torp-tab-header': true,
-				horizontal: $state.orientation === "horizontal",
-				vertical: $state.orientation === "vertical" }}
+			id={$props.id}
+			:class={[
+				"torp-tab-header",
+				$props.class,
+				$state.orientation
+			]}
 			data-state={$state.dataState}
 			data-disabled={$state.dataDisabled}
 		>

package/src/TabGroup/TabList.torp

@@ -1,4 +1,4 @@
-import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from './TabGroupTypes';
+import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from "./TabGroupTypes";
 
 /**
  * A component that holds the TabHeaders of a TabGroup.
@@ -19,7 +19,7 @@ export default function TabList($props: any) {
 	// Get stuff out of the TabGroupContext
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
-		throw new Error('TabList must be contained within an TabGroup');
+		throw new Error("TabList must be contained within a TabGroup");
 	}
 	// TODO: const { orientation } = context;
 	const orientation = context.orientation;
@@ -35,7 +35,8 @@ export default function TabList($props: any) {
 
 	@render {
 		<div
-			class='torp-tab-list'
+			id={$props.id}
+			class={`torp-tab-list ${$props.class ?? ""}`.trim()}
 			role="tablist"
 			aria-label={$props.ariaLabel}
 			aria-orientation={orientation}

package/src/TabGroup/TabTrigger.torp

@@ -1,5 +1,5 @@
-import getId from '../utils/getId';
-import { TabItemContextName, type TabItemContext } from './TabGroupTypes';
+import getId from "../utils/getId";
+import { TabItemContextName, type TabItemContext } from "./TabGroupTypes";
 
 /**
  * A header button for a tab item, which can be used to reveal an associated TabContent.
@@ -12,7 +12,7 @@ export default function TabTrigger() {
 	// Get stuff out of the TabItemContext
 	const context = $context[TabItemContextName] as TabItemContext;
 	if (!context) {
-		throw new Error('TabTrigger must be contained within an TabItem');
+		throw new Error("TabTrigger must be contained within a TabHeader");
 	}
 	let $state = $context[TabItemContextName].state;
 
@@ -25,7 +25,7 @@ export default function TabTrigger() {
 	// This function is called by the parent TabGroup to focus this item's button
 	function setFocused() {
 		button.focus();
-		if ($state.activation === 'automatic') {
+		if ($state.activation === "automatic") {
 			context.triggerItem($state.value);
 		}
 	}
@@ -45,7 +45,7 @@ export default function TabTrigger() {
 		<button
 			type="button"
 			id={$props.id}
-			class='torp-tab-trigger'
+			class={`torp-tab-trigger ${$props.class ?? ""}`.trim()}
 			role="tab"
 			tabindex="-1"
 			disabled={$state.disabled || $state.parentDisabled}
@@ -55,7 +55,7 @@ export default function TabTrigger() {
 			data-state={$state.dataState}
 			data-disabled={$state.disabled}
 			data-orientation={$state.orientation}
-			:self={button}
+			&ref={button}
 			onclick={handleClick}
 			onkeydown={handleKey}
 		>

package/src/mount/disableScroll.ts

@@ -0,0 +1,28 @@
+export function disableScroll(): () => void {
+	// Remember body styles
+	const overflowX = document.body.style.overflowY;
+	const overflowY = document.body.style.overflowY;
+	const overscrollBehaviourX = document.body.style.overscrollBehaviorX;
+	const overscrollBehaviourY = document.body.style.overscrollBehaviorY;
+	const marginRight = document.body.style.marginRight;
+
+	// Get scrollbar width (if visible) so that we can set a margin to avoid things jumping around
+	// HACK: Does this work in all browsers/systems?
+	const scrollBarWidth = window.innerWidth - document.body.clientWidth;
+
+	// Set body styles to disallow scrolling
+	document.body.style.overflowY = "hidden";
+	document.body.style.overflowY = "hidden";
+	document.body.style.overscrollBehaviorX = "contain";
+	document.body.style.overscrollBehaviorY = "contain";
+	document.body.style.marginRight = scrollBarWidth + "px";
+
+	return () => {
+		// Reset body styles
+		document.body.style.overflowY = overflowX;
+		document.body.style.overflowY = overflowY;
+		document.body.style.overscrollBehaviorX = overscrollBehaviourX;
+		document.body.style.overscrollBehaviorY = overscrollBehaviourY;
+		document.body.style.marginRight = marginRight;
+	};
+}