@torpor/ui 0.2.0 → 0.3.0

package/dist/MenuBar/MenuBar.torp

@@ -1,5 +1,16 @@
 import { MenuBarContextName, type MenuBarContext, type ItemState } from "./MenuBarTypes";
 
+interface MenuBarProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the menu to screen readers */
+	ariaLabel?: string,
+	/** The orientation of the menu, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+}
+
 /**
  * A menu bar, similar to that shown at the top of Windows applications or at the top of the screen on Macs.
  *
@@ -9,20 +20,17 @@ import { MenuBarContextName, type MenuBarContext, type ItemState } from "./MenuB
  *
  * ```
  * <MenuBar>
- *     <MenuBarItem>
- *         <MenuBarItemTrigger />
- *         <MenuBarItemContent>
- *             <Menu />
- *         </MenuBarItemContent>
- *     </MenuBarItem>
+ * 	<MenuBarItem>
+ * 		<MenuBarItemTrigger />
+ * 		<MenuBarItemContent>
+ * 			<Menu />
+ * 		</MenuBarItemContent>
+ * 	</MenuBarItem>
  * </MenuBar>
  * ```
- *
- * @prop {string} 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 MenuBar() {
-	$props.orientation ??= "horizontal";
+export default function MenuBar($props: MenuBarProps | undefined) {
+	let orientation = $props?.orientation ?? "horizontal";
 
 	let $state = $watch({
 		active: false,
@@ -43,7 +51,7 @@ export default function MenuBar() {
 	$context[MenuBarContextName] = context;
 
 	function registerItem(setVisible: (value: boolean) => void, setFocused: () => void) {
-		// Add the item"s state to the array and return its index
+		// Add the item's state to the array and return its index
 		const newItemState: ItemState = {
 			setVisible,
 			setFocused
@@ -137,12 +145,12 @@ export default function MenuBar() {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-menu-bar ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar ${$props?.class ?? ""}`.trim()}
 			tabindex="-1"
 			role="menubar"
-			aria-label={$props.ariaLabel}
-			aria-orientation={$props.orientation}
+			aria-label={$props?.ariaLabel}
+			aria-orientation={orientation}
 		>
 			<slot />
 		</div>

package/dist/MenuBar/MenuBarItem.torp

@@ -6,6 +6,21 @@ import {
 } from "./MenuBarTypes";
 import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes";
 
+interface MenuBarItemProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the item is visible */
+	visible?: boolean,
+	/** Raised when the item is opened or closed */
+	ontoggle?: (visible: boolean) => void,
+	/** Raised when the item has opened */
+	onopen?: () => void,
+	/** Raised when the item has closed */
+	onclose?: (result: any) => void,
+}
+
 /**
  * A popout that is attached to a menubar button and can be used to show a submenu.
  *
@@ -13,21 +28,14 @@ import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes
  *
  * ```
  * <MenuBarItem>
- *     <MenuBarItemTrigger /> (optional)
- *     <MenuBarItemContent />
+ * 	<MenuBarItemTrigger /> (optional)
+ * 	<MenuBarItemContent />
  * </MenuBarItem>
  * ```
- *
- * @prop {boolean} visible -- Whether the item is visible
- * @prop {(boolean) => void} ontoggle -- Called when the item is opened or closed
- * @prop {() => void} onopen -- Called when the item has opened
- * @prop {() => void} onclose -- Called when the item has closed
  */
-export default function MenuBarItem() {
-	$props.visible ??= false;
-
+export default function MenuBarItem($props: MenuBarItemProps | undefined) {
 	let $state = $watch({
-		visible: $props.visible
+		visible: $props?.visible ?? false
 	});
 
 	let result: any;
@@ -72,9 +80,9 @@ export default function MenuBarItem() {
 
 	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;
@@ -95,8 +103,8 @@ export default function MenuBarItem() {
 
 	@render {
 		<div 
-			{$props.id}
-			class={`torp-menu-bar-item ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar-item ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/dist/MenuBar/MenuBarItemContent.torp

@@ -7,16 +7,21 @@ import {
 	type MenuBarItemContext
 } from "./MenuBarTypes";
 
+interface MenuBarItemContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Where the popout will be shown, relative to the popout button */
+	side?: "top" | "right" | "bottom" | "left",
+	/** How the popout will be aligned, relative to the popout button */
+	alignment?: "start" | "center" | "end",
+}
+
 /**
  * The content that is displayed for a MenuBarItem 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 MenuBarItemContent() {
-	$props.side ??= "bottom";
-	$props.alignment ??= "start";
-
+export default function MenuBarItemContent($props: MenuBarItemContentProps | undefined) {
 	let div: HTMLDivElement;
 	let closeOnClick = false;
 	let shown = false;
@@ -80,7 +85,7 @@ export default function MenuBarItemContent() {
 
 	function handleDocumentClick(e: MouseEvent) {
 		if (closeOnClick && !div.contains(e.target as HTMLElement)) {
-			context.active = false;
+			//context.active = false;
 			setVisible(false);
 		}
 	}
@@ -90,14 +95,16 @@ export default function MenuBarItemContent() {
 			throw new Error("MenuBarItemContent must have an anchor element");
 		}
 
-		setPopoverPosition(itemContext.anchorElement, div, $props.side, $props.alignment);
+		let side = $props?.side ?? "bottom";
+		let alignment = $props?.alignment ?? "start";
+		setPopoverPosition(itemContext.anchorElement, div, side, alignment);
 	}
 
 	@render {
 		@if ($state.visible) {
 			<div
-				{$props.id}
-				class={`torp-menu-bar-item-content ${$props.class ?? ""}`.trim()}
+				{$props?.id}
+				class={`torp-menu-bar-item-content ${$props?.class ?? ""}`.trim()}
 				&ref={div}
 				onmount={show}
 			>

package/dist/MenuBar/MenuBarItemTrigger.torp

@@ -5,14 +5,20 @@ import {
 	type MenuBarItemContext
 } from "./MenuBarTypes";
 
+interface MenuBarItemTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a MenuBar and opens a submenu.
  *
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function MenuBarItemTrigger() {
-	$props.disabled ??= false;
-
+export default function MenuBarItemTrigger($props: MenuBarItemTriggerProps | undefined) {
 	let button: HTMLButtonElement;
 
 	// Get stuff out of the MenuBarContext
@@ -67,15 +73,15 @@ export default function MenuBarItemTrigger() {
 
 	@render {
 		<button
-			{$props.id}
-			class={`torp-menu-bar-item-button ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-menu-bar-item-button ${$props?.class ?? ""}`.trim()}
 			type="button"
-			{$props.disabled}
+			{$props?.disabled}
 			role="menuitem"
 			aria-haspopup="true"
 			aria-expanded={($state.visible ?? false).toString()}
-			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={$props.disabled ? "true" : undefined}
+			aria-disabled={$props?.disabled ? "true" : undefined}
+			data-disabled={$props?.disabled ? "true" : undefined}
 			onkeydown={handleKey}
 			onclick={handleClick}
 			onfocus={() => handleButtonFocus(index)}

package/dist/MenuBar/index.d.ts

@@ -1,72 +1,123 @@
 import { type SlotRender } from "@torpor/view";
 
 
+interface MenuBarProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the menu to screen readers */
+	ariaLabel?: string,
+	/** The orientation of the menu, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+}
+
 /**
- * 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 menu bar, similar to that shown at the top of Windows applications or at the top of the screen on Macs.
+ *
+ * See [the WAI ARIA guidelines for Menus](https://www.w3.org/WAI/ARIA/apg/patterns/menu/).
+ *
+ * The structure of a MenuBar is:
+ *
+ * ```
+ * <MenuBar>
+ * 	<MenuBarItem>
+ * 		<MenuBarItemTrigger />
+ * 		<MenuBarItemContent>
+ * 			<Menu />
+ * 		</MenuBarItemContent>
+ * 	</MenuBarItem>
+ * </MenuBar>
+ * ```
  */
 declare function MenuBar(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: MenuBarProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface MenuBarItemProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the item is visible */
+	visible?: boolean,
+	/** Raised when the item is opened or closed */
+	ontoggle?: (visible: boolean) => void,
+	/** Raised when the item has opened */
+	onopen?: () => void,
+	/** Raised when the item 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 popout that is attached to a menubar button and can be used to show a submenu.
+ *
+ * The structure of a MenuBarItem is:
+ *
+ * ```
+ * <MenuBarItem>
+ * 	<MenuBarItemTrigger /> (optional)
+ * 	<MenuBarItemContent />
+ * </MenuBarItem>
+ * ```
  */
 declare function MenuBarItem(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: MenuBarItemProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface MenuBarItemContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Where the popout will be shown, relative to the popout button */
+	side?: "top" | "right" | "bottom" | "left",
+	/** How the popout will be aligned, relative to the popout button */
+	alignment?: "start" | "center" | "end",
+}
+
 /**
- * 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 MenuBarItem when it is open.
  */
 declare function MenuBarItemContent(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: MenuBarItemContentProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface MenuBarItemTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
- * 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 button that is placed in a MenuBar and opens a submenu.
+ *
  */
 declare function MenuBarItemTrigger(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: MenuBarItemTriggerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;

package/dist/Modal/Modal.torp

@@ -0,0 +1,118 @@
+import { ModalContextName, type ModalContext, type ModalState } from "./ModalTypes";
+
+interface ModalProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the modal is visible  */
+	visible?: boolean,
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the modal is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the modal has opened */
+	onopen?: () => void,
+	/** Raised when the modal has closed */
+	onclose?: (result: any) => void,
+}
+
+/**
+ * A modal window that can be used to show rich content or obtain information from a user.
+ *
+ * See [the WAI ARIA guidelines for Modals](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/).
+ *
+ * The structure of a Modal is:
+ *
+ * ```
+ * <Modal>
+ * 	<ModalOverlay />
+ * 	<ModalTrigger /> (optional)
+ * 	<ModalContent />
+ * </Modal>
+ * ```
+ */
+export default function Modal($props: ModalProps | undefined) {
+	let $state: ModalState = $watch({
+		visible: false,
+	})
+
+	// Sync props and state
+	$run(() => {
+		$state.visible = $props?.visible ?? false;
+	});
+	$run(() => {
+		if ($props !== undefined) {
+			$props.visible = $state.visible;
+		}
+	});
+
+	let result: any;
+
+	// Set the context to pass down to items
+	let context: ModalContext = {
+		handleButton,
+		handleClickOutside,
+		state: $state,
+	};
+	$context[ModalContextName] = context;
+
+	// Dispatch the toggle event when the modal 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 modal
+		$state.visible = false;
+
+		// Call the callback
+		if ($props?.callback) {
+			$props?.callback(result);
+		}
+	}
+
+	function handleClickOutside(e: MouseEvent) {
+		e.preventDefault();
+		$state.visible = false;
+	}
+
+	@render {
+		<div
+			{$props?.id}
+			class={`torp-modal ${$props?.class ?? ""}`.trim()}
+		>
+			<slot />
+		</div>
+	}
+}

package/dist/Modal/ModalContent.torp

@@ -0,0 +1,77 @@
+import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import { ModalContextName, type ModalContext } from "./ModalTypes";
+
+interface ModalContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The content that is displayed for a Modal when it is open, displayed
+ * alongside an element.
+ */
+export default function ModalContent($props: ModalContentProps | undefined) {
+	let div: HTMLDivElement;
+	let shown = false;
+	let closeOnClick = false;
+
+	// Get stuff out of the ModalContext
+	const context = $context[ModalContextName] as ModalContext;
+	if (!context) {
+		throw new Error("ModalContent must be contained within a Modal");
+	}
+	let $state = context.state;
+
+	$run(() => {
+		if (!$state.visible) {
+			hide();
+		}
+	});
+
+	function show() {
+		shown = true;
+
+		// HACK: Because this Modal 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);
+	}
+
+	function hide() {
+		if (!shown) return;
+
+		removeDocumentEvent("mousedown", handleDocumentMouseDown);
+		removeDocumentEvent("click", handleDocumentClick);
+	}
+
+	function handleDocumentMouseDown() {
+		closeOnClick = true;
+	}
+
+	function handleDocumentClick(e: MouseEvent) {
+		if (
+			closeOnClick &&
+			div &&
+			!div.contains(e.target as HTMLElement)
+		) {
+			e.preventDefault();
+			context.handleClickOutside!(e);
+		}
+	}
+
+	@render {
+		@if ($state.visible) {
+			<div
+				{$props?.id}
+				class={`torp-modal-content ${$props?.class ?? ""}`.trim()}
+				&ref={div}
+				onmount={show}
+			>
+				<slot />
+			</div>
+		}
+	}
+}

package/dist/Modal/ModalOverlay.torp

@@ -0,0 +1,38 @@
+import { disableScroll } from "../mount/disableScroll";
+import { ModalContextName, type ModalContext } from "./ModalTypes";
+
+interface ModalOverlayProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The background overlay for a modal popup component (e.g. Context, Dialog or Popover).
+ * Adding an overlay automatically sets the component's `modal` value to true.
+ */
+export default function ModalOverlay($props: ModalOverlayProps | undefined) {
+	// Get stuff out of the ModalContext
+	const context = $context[ModalContextName] as ModalContext;
+	if (!context) {
+		throw new Error("ModalOverlay must be contained within a Modal");
+	}
+	let $state = context.state;
+
+	// Any popup with an overlay is modal
+	$state.modal = true;
+
+	@render {
+		@if ($state.visible) {
+			<div
+				{$props?.id}
+				class={`torp-modal-overlay ${$props?.class ?? ""}`.trim()}
+				tabindex="-1"
+				onmount={(el) => disableScroll(el)}
+			>
+				<slot />
+			</div>
+		}
+	}
+}

package/dist/Modal/ModalTrigger.torp

@@ -0,0 +1,50 @@
+import { ModalContextName, type ModalContext } from "./ModalTypes";
+import hoverTrigger from "../mount/hoverTrigger";
+
+interface ModalTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the modal is activated by click/press or by hover **/
+	activation?: "press" | "hover"
+}
+
+/**
+ * The button that causes a Modal to appear or disappear.
+ */
+export default function ModalTrigger($props: ModalTriggerProps | undefined) {
+	let activation = $props?.activation ?? "press";
+
+	// Get stuff out of the ModalContext
+	const context = $context[ModalContextName] as ModalContext;
+	if (!context) {
+		throw new Error("ModalTrigger must be contained within a Modal");
+	}
+	let $state = context.state;
+
+	function handleClick() {
+		if (activation !== "press") return;
+
+		$state.visible = !$state.visible;
+	}
+
+	function handleHover() {
+		if (activation !== "hover") return;
+
+		$state.visible = !$state.visible
+	}
+
+	@render {
+		<button
+			type="button"
+			{$props?.id}
+			class={`torp-modal-trigger ${$props?.class ?? ""}`.trim()}
+			onclick={handleClick}
+			onmount={(el) => hoverTrigger(el, { onHover: handleHover, onExit: handleHover })}
+			&ref={context.anchorElement}
+		>
+			<slot />
+		</button>
+	}
+}