@torpor/ui 0.2.0 → 0.3.0

package/dist/Notification/index.d.ts

@@ -1,72 +1,90 @@
 import { type SlotRender } from "@torpor/view";
 
 
+interface NotificationProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the notification is visible */
+	visible?: boolean,
+	/** The duration, in milliseconds, to keep the notification visible */
+	duration?: number,
+	/** Raised when the notification has closed, either after the duration has elapsed, or when the user has pressed the close button */
+	onclose?: () => 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.
+ * 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/).
  */
 declare function Notification(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props,
+	$props: NotificationProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface NotificationCloseProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
- * 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.
+ * The button that a user can press to close this Notification.
  */
 declare function NotificationClose(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: NotificationCloseProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface NotificationContainerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
- * 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.
+ * The container for one or more Notifications, which can be used to position
+ * the notifications inside the viewport.
  */
 declare function NotificationContainer(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: NotificationContainerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface NotificationContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
- * 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.
+ * The content to display within a Notification.
  */
 declare function NotificationContent(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: NotificationContentProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;

package/dist/Popover/Popover.torp

@@ -1,31 +1,57 @@
 import { PopoverContextName, type Point, type PopoverContext, type PopoverState } from "./PopoverTypes";
 
+interface PopoverProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** 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  */
+	modal?: boolean,
+	/** Whether the popover is visible  */
+	visible?: boolean,
+	/** The element to anchor this popover to, as an alternative to supplying a PopoverTrigger  */
+	anchor?: HTMLElement,
+	/** The position to display this popover at if it's contextual, as an alternative to supplying a PopoverTriggerContextual  */
+	position?: Point,
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the popover is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the popover has opened */
+	onopen?: () => void,
+	/** Raised when the popover has closed */
+	onclose?: (result: any) => void,
+}
+
 /**
- * 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/).
+ * A popover window that is shown to the user relative to an anchor element.
  *
  * The structure of a Popover is:
  *
  * ```
  * <Popover>
- * 	<PopoverOverlay /> (optional, if modal)
- * 	<PopoverTrigger/PopoverTriggerContextual/PopoverTriggerHover /> (optional)
- * 	<PopoverContent/PopoverContentAnchored/PopoverContentContextual />
+ * 	<PopoverTrigger /> (optional)
+ * 	<PopoverContent />
  * </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) {
+export default function Popover($props: PopoverProps | undefined) {
 	let $state: PopoverState = $watch({
 		visible: false,
 		position: { x: 0, y: 0 }
 	})
 
+	// Sync props and state
+	$run(() => {
+		$state.visible = $props?.visible ?? false;
+		$state.position = $props?.position ?? { x: 0, y: 0 };
+	});
+	$run(() => {
+		if ($props !== undefined) {
+			$props.visible = $state.visible;
+		}
+	});
+
 	let result: any;
 
 	// Set the context to pass down to items
@@ -33,23 +59,17 @@ export default function Popover($props: any) {
 		handleButton,
 		handleClickOutside,
 		state: $state,
-		modal: $props.modal,
-		anchorElement: $unwrap($props.anchor),
+		modal: $props?.modal,
+		anchorElement: $props?.anchor ? $unwrap($props.anchor) : undefined,
 	};
 	$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
+	// Dispatch the toggle event when the popover is opened or closed
 	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;
@@ -84,8 +104,8 @@ export default function Popover($props: any) {
 		$state.visible = false;
 
 		// Call the callback
-		if ($props.callback) {
-			$props.callback(result);
+		if ($props?.callback) {
+			$props?.callback(result);
 		}
 	}
 
@@ -96,8 +116,8 @@ export default function Popover($props: any) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-popover ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-popover ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/dist/Popover/PopoverContent.torp

@@ -1,11 +1,24 @@
 import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import getScrollParent from "../utils/getScrollParent";
+import setPopoverPosition from "../utils/setPopoverPosition";
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Where the popover will be shown, relative to the popover trigger */
+	side?: "top" | "right" | "bottom" | "left",
+	/** How the popover will be aligned, relative to the popover trigger */
+	alignment?: "start" | "center" | "end",
+}
+
 /**
- * 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.
+ * The content that is displayed for a Popover when it is open, displayed
+ * alongside an element.
  */
-export default function PopoverContent($props: any) {
+export default function PopoverContent($props?: PopoverContentProps | undefined) {
 	let div: HTMLDivElement;
 	let shown = false;
 	let closeOnClick = false;
@@ -32,6 +45,12 @@ export default function PopoverContent($props: any) {
 		addDocumentEvent("mousedown", handleDocumentMouseDown);
 		addDocumentEvent("click", handleDocumentClick);
 
+		// Set the position and listen for window resize and scroll to reset the position
+		setPosition();
+		const anchorElement = context.anchorElement!
+		const scrollParent = getScrollParent(anchorElement)
+		scrollParent.addEventListener("resize", setPosition);
+		scrollParent.addEventListener("scroll", setPosition);
 		if (context.focusFirstElement) {
 			context.focusFirstElement();
 		}
@@ -43,9 +62,13 @@ export default function PopoverContent($props: any) {
 		removeDocumentEvent("mousedown", handleDocumentMouseDown);
 		removeDocumentEvent("click", handleDocumentClick);
 
-		// Focus the anchor element per WAI guidelines
-		if (context.anchorElement?.focus) {
-			context.anchorElement.focus();
+		// Stop listening for window resize and focus the anchor element per WAI guidelines
+		const anchorElement = context.anchorElement!
+		const scrollParent = getScrollParent(anchorElement)
+		scrollParent.removeEventListener("resize", setPosition);
+		scrollParent.removeEventListener("scroll", setPosition);
+		if (anchorElement.focus) {
+			anchorElement.focus();
 		}
 	}
 
@@ -60,15 +83,26 @@ export default function PopoverContent($props: any) {
 			!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("Popover must have an anchor element");
+		}
+
+		let side = $props?.side ?? "bottom";
+		let alignment = $props?.alignment ?? "center";
+		setPopoverPosition(context.anchorElement, div, side, alignment);
+	}
+
 	@render {
 		@if ($state.visible) {
 			<div
-				{$props.id}
-				class={`torp-popover-content ${$props.class ?? ""}`.trim()}
+				{$props?.id}
+				class={`torp-popover-content ${$props?.class ?? ""}`.trim()}
 				&ref={div}
 				onmount={show}
 			>

package/dist/Popover/PopoverTrigger.torp

@@ -1,9 +1,21 @@
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
+import hoverTrigger from "../mount/hoverTrigger";
+
+interface PopoverTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the popover is activated by click/press or by hover **/
+	activation?: "press" | "hover"
+}
 
 /**
  * The button that causes a Popover to appear or disappear.
  */
-export default function PopoverTrigger($props: any) {
+export default function PopoverTrigger($props: PopoverTriggerProps | undefined) {
+	let activation = $props?.activation ?? "press";
+
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
 	if (!context) {
@@ -12,15 +24,32 @@ export default function PopoverTrigger($props: any) {
 	let $state = context.state;
 
 	function handleClick() {
+		if (activation !== "press") return;
+
 		$state.visible = !$state.visible;
 	}
 
+	function handleHover(node: HTMLElement, e: MouseEvent) {
+		if (activation !== "hover") return;
+
+		if ($state.position) {
+			// Get the position relative to the element, so we can reposition on scroll
+			const rect = node.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 {
 		<button
 			type="button"
-			{$props.id}
-			class={`torp-popover-trigger ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-popover-trigger ${$props?.class ?? ""}`.trim()}
 			onclick={handleClick}
+			onmount={(el) => hoverTrigger(el, { onHover: handleHover, onExit: handleHover })}
 			&ref={context.anchorElement}
 		>
 			<slot />

package/dist/Popover/PopoverTypes.ts

@@ -7,7 +7,7 @@ export interface PopoverContext {
 	// There may be a more elegant way to accomplish this too
 	handleClickOutside?: (e: MouseEvent) => void;
 	state: PopoverState;
-	modal: boolean;
+	//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

package/dist/Popover/index.d.ts

@@ -1,18 +1,45 @@
 import { type SlotRender } from "@torpor/view";
 
 
+interface PopoverProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** 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  */
+	modal?: boolean,
+	/** Whether the popover is visible  */
+	visible?: boolean,
+	/** The element to anchor this popover to, as an alternative to supplying a PopoverTrigger  */
+	anchor?: HTMLElement,
+	/** The position to display this popover at if it's contextual, as an alternative to supplying a PopoverTriggerContextual  */
+	position?: Point,
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the popover is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the popover has opened */
+	onopen?: () => void,
+	/** Raised when the popover has closed */
+	onclose?: (result: any) => 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.
+ * A popover window that is shown to the user relative to an anchor element.
+ *
+ * The structure of a Popover is:
+ *
+ * ```
+ * <Popover>
+ * 	<PopoverTrigger /> (optional)
+ * 	<PopoverContent />
+ * </Popover>
+ * ```
  */
 declare function Popover(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: PopoverProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
@@ -20,127 +47,37 @@ declare function Popover(
 
 
 /**
- * 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.
+ * The content that is displayed for a Popover when it is open, displayed
+ * alongside an element.
  */
 declare function PopoverContent(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props?: PopoverContentProps | undefined,
 	$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 PopoverContentAnchored(
-	$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 PopoverContentContextual(
-	$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 PopoverOverlay(
-	$parent: ParentNode,
-	$anchor: Node | null,
-	$props: any,
-	$context?: Record<PropertyKey, any>,
-	$slots?: Record<string, SlotRender>,
-): void;
-
-
+interface PopoverTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the popover is activated by click/press or by hover **/
+	activation?: "press" | "hover"
+}
 
 /**
- * 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.
+ * The button that causes a Popover to appear or disappear.
  */
 declare function PopoverTrigger(
 	$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 PopoverTriggerContextual(
-	$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 PopoverTriggerHover(
-	$parent: ParentNode,
-	$anchor: Node | null,
-	$props: any,
+	$props: PopoverTriggerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
-export { Popover, PopoverContent, PopoverContentAnchored, PopoverContentContextual, PopoverOverlay, PopoverTrigger, PopoverTriggerContextual, PopoverTriggerHover };
+export { Popover, PopoverContent, PopoverTrigger };