@torpor/ui 0.1.7 → 0.2.0

package/dist/NavMenu/index.d.ts

@@ -0,0 +1,182 @@
+import { type SlotRender } from "@torpor/view";
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenu(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuButton(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuElement(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuGroup(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuGroupHeader(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuLink(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuPopout(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuPopoutButton(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuPopoutContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NavMenuSeparator(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: any,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { NavMenu, NavMenuButton, NavMenuElement, NavMenuGroup, NavMenuGroupHeader, NavMenuLink, NavMenuPopout, NavMenuPopoutButton, NavMenuPopoutContent, NavMenuSeparator };

package/dist/Notification/Notification.torp

@@ -0,0 +1,48 @@
+import { NotificationContextName, type NotificationContext } from "./NotificationTypes";
+
+/**
+ * An element that displays a brief, important message in a way that attracts
+ * the user's attention without interrupting the user's task.
+ *
+ * See [the WAI ARIA guidelines for Alerts](https://www.w3.org/WAI/ARIA/apg/patterns/alert/).
+ *
+ * @prop {boolean} visible -- Whether the notification is visible
+ * @prop {number | undefined} duration -- The duration, in milliseconds, to keep the notification visible
+ * @prop {() => void} onclose -- Raised when the notification has closed, either after the duration has elapsed, or when the user has pressed the close button
+ */
+export default function Notification($props) {
+	$props.visible ??= true;
+	$props.duration ??= 5000;
+
+	// Set the context to pass down to items
+	let context: NotificationContext = {
+		closeNotification
+	};
+	$context[NotificationContextName] = context;
+
+	$mount(() => {
+		if ($props.duration) {
+			setTimeout(closeNotification, $props.duration);
+		}
+	});
+
+	function closeNotification() {
+		$props.visible = false;
+
+		if ($props.onclose) {
+			$props.onclose();
+		}
+	}
+
+	@render {
+		@if ($props.visible) {
+			<div 
+				{$props.id}
+				class={`torp-notification ${$props.class ?? ""}`.trim()}
+				role="alert"
+			>
+				<slot />
+			</div>
+		}
+	}
+}

package/dist/Notification/NotificationClose.torp

@@ -0,0 +1,28 @@
+import { NotificationContextName, type NotificationContext } from "./NotificationTypes";
+
+/**
+ * The button that a user can press to close this Notification.
+ */
+export default function NotificationClose() {
+	// Get stuff out of the NotificationContext
+	const context = $context[NotificationContextName] as NotificationContext;
+	if (!context) {
+		throw new Error("NotificationClose must be contained within a Notification");
+	}
+	const { closeNotification } = context;
+
+	function handleClick() {
+		closeNotification();
+	}
+
+	@render {
+		<button
+			{$props.id}
+			class={`torp-notification-close ${$props.class ?? ""}`.trim()}
+			type="button"
+			onclick={handleClick}
+		>
+			<slot />
+		</button>
+	}
+}

package/dist/Notification/NotificationContainer.torp

@@ -0,0 +1,14 @@
+/**
+ * The container for one or more Notifications, which can be used to position
+ * the notifications inside the viewport.
+ */
+export default function NotificationContainer() {
+	@render {
+		<div
+			{$props.id}
+			class={`torp-notification-container ${$props.class ?? ""}`.trim()}
+		>
+			<slot />
+		</div>
+	}
+}

package/dist/Notification/NotificationContent.torp

@@ -0,0 +1,13 @@
+/**
+ * The content to display within a Notification.
+ */
+export default function NotificationContent() {
+	@render {
+		<div 
+			{$props.id}
+			class={`torp-notification-content ${$props.class ?? ""}`.trim()}
+		>
+			<slot />
+		</div>
+	}
+}

package/dist/Notification/NotificationTypes.ts

@@ -0,0 +1,5 @@
+export const NotificationContextName = 'Notification';
+
+export interface NotificationContext {
+	closeNotification: () => void;
+}

package/dist/Notification/index.d.ts

@@ -0,0 +1,74 @@
+import { type SlotRender } from "@torpor/view";
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function Notification(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NotificationClose(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props?: Record<PropertyKey, any>,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NotificationContainer(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props?: Record<PropertyKey, any>,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+/**
+ * Mounts or hydrates the component into the supplied parent node.
+ * @param $parent -- The parent node.
+ * @param $anchor -- The node to mount the component before.
+ * @param $props -- The values that have been passed into the component as properties.
+ * @param $context -- Values that have been passed into the component from its ancestors.
+ * @param $slots -- Functions for rendering children into slot nodes within the component.
+ */
+declare function NotificationContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props?: Record<PropertyKey, any>,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { Notification, NotificationClose, NotificationContainer, NotificationContent };

package/dist/Notification/index.js

@@ -0,0 +1,36 @@
+// src/Notification/Notification.torp
+import Notification_default from "./Notification.torp";
+
+// src/Notification/NotificationClose.torp
+import NotificationClose_default from "./NotificationClose.torp";
+
+// src/Notification/NotificationContainer.torp
+import NotificationContainer_default from "./NotificationContainer.torp";
+
+// src/Notification/NotificationContent.torp
+import NotificationContent_default from "./NotificationContent.torp";
+
+// src/Notification/showNotification.ts
+import { mount } from "@torpor/view";
+function showNotification(notification, props, target) {
+  if (!target) {
+    target = document.getElementsByClassName("torp-notification-container")[0];
+    if (!target) {
+      throw new Error("No notification container found");
+    }
+  }
+  var fragment = document.createDocumentFragment();
+  while (target.firstChild) {
+    fragment.append(target.firstChild);
+  }
+  mount(target, notification, props);
+  target.prepend(fragment);
+}
+export {
+  Notification_default as Notification,
+  NotificationClose_default as NotificationClose,
+  NotificationContainer_default as NotificationContainer,
+  NotificationContent_default as NotificationContent,
+  showNotification
+};
+//# sourceMappingURL=index.js.map

package/dist/Notification/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Notification/showNotification.ts"],"sourcesContent":["import { mount } from \"@torpor/view\";\n\n/**\n * Shows a notification component in code.\n * @param notification The notification component\n * @param props The properties for the notification component\n * @param target The target element to show the notification in\n */\nexport default function showNotification(notification: any, props: any, target?: Element): void {\n\tif (!target) {\n\t\t// Put the notification in the first NotificationContainer, or the\n\t\t// document body if there are no NotificationContainers\n\t\ttarget = document.getElementsByClassName(\"torp-notification-container\")[0];\n\t\tif (!target) {\n\t\t\tthrow new Error(\"No notification container found\");\n\t\t}\n\t}\n\n\t// HACK: Should allow mounting in a non-empty container\n\t// Move existing nodes into a fragment, and add them back after mounting\n\tvar fragment = document.createDocumentFragment();\n\twhile (target.firstChild) {\n\t\tfragment.append(target.firstChild);\n\t}\n\n\t// Create the notification\n\tmount(target, notification, props);\n\n\ttarget.prepend(fragment);\n}\n"],"mappings":";;;;;;;;;;;;;AAAA,SAAS,aAAa;AAQP,SAAR,iBAAkC,cAAmB,OAAY,QAAwB;AAC/F,MAAI,CAAC,QAAQ;AAGZ,aAAS,SAAS,uBAAuB,6BAA6B,EAAE,CAAC;AACzE,QAAI,CAAC,QAAQ;AACZ,YAAM,IAAI,MAAM,iCAAiC;AAAA,IAClD;AAAA,EACD;AAIA,MAAI,WAAW,SAAS,uBAAuB;AAC/C,SAAO,OAAO,YAAY;AACzB,aAAS,OAAO,OAAO,UAAU;AAAA,EAClC;AAGA,QAAM,QAAQ,cAAc,KAAK;AAEjC,SAAO,QAAQ,QAAQ;AACxB;","names":[]}

package/dist/Notification/showNotification.ts

@@ -0,0 +1,30 @@
+import { mount } from "@torpor/view";
+
+/**
+ * Shows a notification component in code.
+ * @param notification The notification component
+ * @param props The properties for the notification component
+ * @param target The target element to show the notification in
+ */
+export default function showNotification(notification: any, props: any, target?: Element): void {
+	if (!target) {
+		// Put the notification in the first NotificationContainer, or the
+		// document body if there are no NotificationContainers
+		target = document.getElementsByClassName("torp-notification-container")[0];
+		if (!target) {
+			throw new Error("No notification container found");
+		}
+	}
+
+	// HACK: Should allow mounting in a non-empty container
+	// Move existing nodes into a fragment, and add them back after mounting
+	var fragment = document.createDocumentFragment();
+	while (target.firstChild) {
+		fragment.append(target.firstChild);
+	}
+
+	// Create the notification
+	mount(target, notification, props);
+
+	target.prepend(fragment);
+}

package/dist/Popover/Popover.torp

@@ -96,10 +96,10 @@ export default function Popover($props: any) {
 
 	@render {
 		<div
-			id={$props.id}
+			{$props.id}
 			class={`torp-popover ${$props.class ?? ""}`.trim()}
 		>
-			<:slot />
+			<slot />
 		</div>
 	}
 }

package/dist/Popover/PopoverContent.torp

@@ -7,6 +7,8 @@ import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
  */
 export default function PopoverContent($props: any) {
 	let div: HTMLDivElement;
+	let shown = false;
+	let closeOnClick = false;
 
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
@@ -15,37 +17,37 @@ export default function PopoverContent($props: any) {
 	}
 	let $state = context.state;
 
-	let closeOnClick = false;
-
-	let first = true;
 	$run(() => {
-		let visible = $state.visible;
+		if (!$state.visible) {
+			hide();
+		}
+	});
+
+	function show() {
+		shown = true;
 
-		if (first) {
-			first = false;
-			return;
+		// 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);
+
+		if (context.focusFirstElement) {
+			context.focusFirstElement();
 		}
+	}
+
+	function hide() {
+		if (!shown) 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();
-			}
+		removeDocumentEvent("mousedown", handleDocumentMouseDown);
+		removeDocumentEvent("click", handleDocumentClick);
+
+		// Focus the anchor element per WAI guidelines
+		if (context.anchorElement?.focus) {
+			context.anchorElement.focus();
 		}
-	});
+	}
 
 	function handleDocumentMouseDown() {
 		closeOnClick = true;
@@ -65,11 +67,12 @@ export default function PopoverContent($props: any) {
 	@render {
 		@if ($state.visible) {
 			<div
-				id={$props.id}
+				{$props.id}
 				class={`torp-popover-content ${$props.class ?? ""}`.trim()}
 				&ref={div}
+				onmount={show}
 			>
-				<:slot />
+				<slot />
 			</div>
 		}
 	}

package/dist/Popover/PopoverContentAnchored.torp

@@ -17,7 +17,7 @@ export default function PopoverContentAnchored($props: any) {
 	$props.alignment ??= "center";
 
 	let div: HTMLDivElement;
-
+	let shown = false;
 	let closeOnClick = false;
 
 	// Get stuff out of the PopoverContext
@@ -27,42 +27,45 @@ export default function PopoverContentAnchored($props: any) {
 	}
 	let $state = context.state;
 
-	let first = true;
 	$run(() => {
-		let visible = $state.visible;
+		if (!$state.visible) {
+			hide();
+		}
+	});
 
-		if (first) {
-			first = false;
-			return;
+	function show() {
+		shown = true;
+
+		// 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);
+
+		// Set the position and listen for window resize and scroll to reset the position
+		setPosition();
+		const scrollParent = getScrollParent(context.anchorElement)
+		scrollParent.addEventListener("resize", setPosition);
+		scrollParent.addEventListener("scroll", setPosition);
+		if (context.focusFirstElement) {
+			context.focusFirstElement();
 		}
+	}
 
-		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 hide() {
+		if (!shown) return;
+
+		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;
@@ -85,20 +88,18 @@ export default function PopoverContentAnchored($props: any) {
 			throw new Error("PopoverContentAnchored must have an anchor element");
 		}
 
-		if (div) {
-			setPopoverPosition(context.anchorElement, div, $props.side, $props.alignment);
-		}
+		setPopoverPosition(context.anchorElement, div, $props.side, $props.alignment);
 	}
 
 	@render {
 		@if ($state.visible) {
 			<div
-				id={$props.id}
+				{$props.id}
 				class={`torp-popover-content-anchored ${$props.class ?? ""}`.trim()}
 				&ref={div}
-				:onmount={(el) => setPopoverPosition(context.anchorElement, el, $props.side, $props.alignment)}
+				onmount={show}
 			>
-				<:slot />
+				<slot />
 			</div>
 		}
 	}