@torpor/ui 0.2.0 → 0.2.1

package/src/NavMenu/NavMenu.torp

@@ -6,6 +6,17 @@ import {
 	type NavMenuPopoutContext
 } from "./NavMenuTypes";
 
+interface NavMenuProps {
+	/** 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 | undefined,
+	/** The orientation of the menu, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+}
+
 /**
  * A list of links for navigating a website.
  *
@@ -21,11 +32,9 @@ import {
  *	 ...
  * </NavMenu>
  * ```
- *
- * @prop {string | undefined} 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 NavMenu($props: any) {
+export default function NavMenu($props: NavMenuProps) {
+	$props ??= $watch({});
 	$props.orientation ||= "horizontal";
 
 	// A collection containing the state and some functions for each item

package/src/NavMenu/NavMenuButton.torp

@@ -1,13 +1,20 @@
 import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
 
+interface NavMenuButtonProps {
+	/** 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 NavMenu to carry out a non-navigation action such as logging out.
  *
- * @prop {boolean} disabled -- Whether this button is disabled 
  */
-export default function NavMenuButton($props: any) {
-	/** Set when the item is disabled */
-	let dataDisabled = $props.disabled || undefined;
+export default function NavMenuButton($props: NavMenuButtonProps) {
+	$props ??= $watch({});
 
 	let button: HTMLButtonElement;
 
@@ -33,7 +40,7 @@ export default function NavMenuButton($props: any) {
 			{$props.disabled}
 			role="menuitem"
 			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={dataDisabled}
+			data-disabled={$props.disabled ? "true" : undefined}
 			onkeydown
 			onkeydown={handleItemKey}
 			onclick

package/src/NavMenu/NavMenuElement.torp

@@ -1,14 +1,22 @@
 import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
 
+interface NavMenuElementProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this button is disabled  */
+	disabled?: boolean,
+	/** An element that can be focused via keyboard navigation */
+	element?: HTMLElement,
+}
+
 /**
  * An element of any type that can be placed in a NavMenu.
  *
- * @prop {boolean} disabled -- Whether this button is disabled 
- * @prop {HTMLElement} element -- An element that can be focused via keyboard navigation
  */
-export default function NavMenuElement($props: any) {
-	/** Set when the item is disabled */
-	let dataDisabled = $props.disabled || undefined;
+export default function NavMenuElement($props: NavMenuElementProps) {
+	$props ??= $watch({});
 
 	// Get stuff out of the NavMenuContext
 	const menuContext = $context[NavMenuContextName] as NavMenuContext;
@@ -31,7 +39,7 @@ export default function NavMenuElement($props: any) {
 			type="div"
 			role="menuitem"
 			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={dataDisabled}
+			data-disabled={$props.disabled ? "true" : undefined}
 			onkeydown
 			onkeydown={handleItemKey}
 			onclick

package/src/NavMenu/NavMenuGroup.torp

@@ -1,11 +1,20 @@
 import { NavMenuGroupContextName, type NavMenuGroupContext } from "./NavMenuTypes";
 
+interface NavMenuGroupProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the group to screen readers  */
+	ariaLabel?: string,
+}
+
 /**
  * A container for a logical group of navigation menu items.
- *
- * @prop {string | undefined} ariaLabel -- An ARIA label for describing the group to screen readers 
  */
-export default function NavMenuGroup($props: any) {
+export default function NavMenuGroup($props: NavMenuGroupProps) {
+	$props ??= $watch({});
+
 	let $state = $watch({
 		headerId: ""
 	});

package/src/NavMenu/NavMenuGroupHeader.torp

@@ -1,12 +1,20 @@
 import getId from "../utils/getId";
 import { NavMenuGroupContextName, type NavMenuGroupContext } from "./NavMenuTypes";
 
+interface NavMenuGroupHeaderProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The type of HTML header to use */
+	as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6",
+}
+
 /**
  * The header for a NavMenuGroup.
- *
- * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
  */
-export default function NavMenuGroupHeader($props: any) {
+export default function NavMenuGroupHeader($props: NavMenuGroupHeaderProps) {
+	$props ??= $watch({});
 	$props.id ??= getId();
 
 	const context = $context[NavMenuGroupContextName] as NavMenuGroupContext;
@@ -19,8 +27,8 @@ export default function NavMenuGroupHeader($props: any) {
 	$state.headerId = $props.id;
 
 	@render {
+		@// TODO: self={$props.as}
 		<h4
-			@// TODO: self={$props.as}
 			{$props.id}
 			class={`torp-nav-menu-group-header ${$props.class ?? ""}`.trim()}
 		>

package/src/NavMenu/NavMenuLink.torp

@@ -1,19 +1,27 @@
 
 import { NavMenuContextName, type NavMenuContext } from "./NavMenuTypes";
 
+interface NavMenuLinkProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The URL for the menu link */
+	href: string,
+	/** Whether the menu link should open in a new tab/window */
+	newWindow?: boolean,
+	/** Whether this link is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A link that is placed in a NavMenu and signals a response by a user.
  *
- * @prop {string} href -- The URL for the menu link
- * @prop {newWindow} boolean -- Whether the menu link should open in a new tab/window
- * @prop {boolean} disabled -- Whether this link is disabled
  */
-export default function NavMenuLink($props: any) {
+export default function NavMenuLink($props: NavMenuLinkProps) {
+	$props ??= $watch({ href: "#" });
 	$props.newWindow ??= false;
 
-	/** Set when the item is disabled */
-	let dataDisabled = $props.disabled || undefined;
-
 	let link: HTMLAnchorElement;
 
 	// Get stuff out of the NavMenuContext
@@ -39,7 +47,7 @@ export default function NavMenuLink($props: any) {
 			target={$props.newWindow ? "_blank" : undefined}
 			role="menuitem"
 			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={dataDisabled}
+			data-disabled={$props.disabled ? "true" : undefined}
 			onkeydown
 			onkeydown={handleItemKey}
 			onclick

package/src/NavMenu/NavMenuPopout.torp

@@ -1,5 +1,14 @@
 import { NavMenuPopoutContextName, type NavMenuPopoutContext } from "./NavMenuTypes";
 
+interface NavMenuPopoutProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the popout is visible */
+	visible?: boolean,
+}
+
 /**
  * A popout that is attached to a menu button and can be used to show a submenu.
  *
@@ -11,10 +20,9 @@ import { NavMenuPopoutContextName, type NavMenuPopoutContext } from "./NavMenuTy
  * 	<NavMenuPopoutContent />
  * </NavMenuPopout>
  * ```
- *
- * @prop {boolean} visible -- Whether the popout is visible
  */
-export default function NavMenuPopout($props: any) {
+export default function NavMenuPopout($props: NavMenuPopoutProps) {
+	$props ??= $watch({});
 	$props.visible ??= false;
 
 	let $state = $watch({

package/src/NavMenu/NavMenuPopoutButton.torp

@@ -1,4 +1,3 @@
-
 import {
 	NavMenuContextName,
 	NavMenuPopoutContextName,
@@ -6,18 +5,25 @@ import {
 	type NavMenuPopoutContext,
 } from "./NavMenuTypes";
 
+interface NavMenuPopoutButtonProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The delay before showing the popout, in milliseconds */
+	hoverDelay?: number,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
 /**
  * A button that is placed in a NavMenu and signals a response by a user.
  *
- * @prop {number} hoverDelay -- The delay before showing the popout, in milliseconds
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function NavMenuPopoutButton($props: any) {
+export default function NavMenuPopoutButton($props: NavMenuPopoutButtonProps) {
+	$props ??= $watch({});
 	$props.hoverDelay ??= 500;
 
-	/** Set when the item is disabled */
-	let dataDisabled = $props.disabled || undefined;
-
 	let button: HTMLButtonElement;
 	let interval: NodeJS.Timeout | undefined;
 
@@ -104,7 +110,7 @@ export default function NavMenuPopoutButton($props: any) {
 			aria-haspopup="true"
 			aria-expanded={$state.visible.toString()}
 			aria-disabled={$props.disabled ? "true" : undefined}
-			data-disabled={dataDisabled}
+			data-disabled={$state.disabled ? "true" : undefined}
 			onkeydown={handlePopoutKey}
 			onclick={handleClick}
 			onfocus={() => handleItemFocus(index)}

package/src/NavMenu/NavMenuPopoutContent.torp

@@ -3,13 +3,23 @@ import getScrollParent from "../utils/getScrollParent";
 import setPopoverPosition from "../utils/setPopoverPosition";
 import { NavMenuPopoutContextName, type NavMenuPopoutContext } from "./NavMenuTypes";
 
+interface NavMenuPopoutContentProps {
+	/** 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 NavMenuPopout 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 NavMenuPopoutContent($props: any) {
+export default function NavMenuPopoutContent($props: NavMenuPopoutContentProps) {
+	$props ??= $watch({});
 	$props.side ??= "bottom";
 	$props.alignment ??= "start";
 

package/src/NavMenu/NavMenuSeparator.torp

@@ -1,8 +1,17 @@
 
+interface NavMenuSeparatorProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * An element in a menu that separates logical sets of menu items.
  */
-export default function NavMenuSeparator($props: any) {
+export default function NavMenuSeparator($props: NavMenuSeparatorProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div
 			{$props.id}

package/src/Notification/Notification.torp

@@ -1,16 +1,26 @@
 import { NotificationContextName, type NotificationContext } from "./NotificationTypes";
 
+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,
+}
+
 /**
  * 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) {
+export default function Notification($props: NotificationProps) {
+	$props ??= $watch({});
 	$props.visible ??= true;
 	$props.duration ??= 5000;
 

package/src/Notification/NotificationClose.torp

@@ -1,9 +1,18 @@
 import { NotificationContextName, type NotificationContext } from "./NotificationTypes";
 
+interface NotificationCloseProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The button that a user can press to close this Notification.
  */
-export default function NotificationClose() {
+export default function NotificationClose($props: NotificationCloseProps) {
+	$props ??= $watch({});
+
 	// Get stuff out of the NotificationContext
 	const context = $context[NotificationContextName] as NotificationContext;
 	if (!context) {

package/src/Notification/NotificationContainer.torp

@@ -1,8 +1,18 @@
+
+interface NotificationContainerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The container for one or more Notifications, which can be used to position
  * the notifications inside the viewport.
  */
-export default function NotificationContainer() {
+export default function NotificationContainer($props: NotificationContainerProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div
 			{$props.id}

package/src/Notification/NotificationContent.torp

@@ -1,7 +1,17 @@
+
+interface NotificationContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The content to display within a Notification.
  */
-export default function NotificationContent() {
+export default function NotificationContent($props: NotificationContentProps) {
+	$props ??= $watch({});
+
 	@render {
 		<div 
 			{$props.id}

package/src/Popover/Popover.torp

@@ -1,5 +1,22 @@
 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),
+}
+
 /**
  * A popover that can be used to show rich content or obtain information from a user.
  *
@@ -14,13 +31,10 @@ import { PopoverContextName, type Point, type PopoverContext, type PopoverState
  * 	<PopoverContent/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) {
+export default function Popover($props: PopoverProps) {
+	$props ??= $watch({});
+
 	let $state: PopoverState = $watch({
 		visible: false,
 		position: { x: 0, y: 0 }

package/src/Popover/PopoverContent.torp

@@ -1,11 +1,20 @@
 import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
 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,
+}
+
 /**
  * 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 PopoverContent($props: any) {
+export default function PopoverContent($props: PopoverContentProps) {
+	$props ??= $watch({});
+
 	let div: HTMLDivElement;
 	let shown = false;
 	let closeOnClick = false;

package/src/Popover/PopoverContentAnchored.torp

@@ -3,16 +3,23 @@ import getScrollParent from "../utils/getScrollParent";
 import setPopoverPosition from "../utils/setPopoverPosition";
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverContentAnchoredProps {
+	/** 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 button */
+	side?: "top" | "right" | "bottom" | "left",
+	/** How the popover will be aligned, relative to the popover button */
+	alignment?: "start" | "center" | "end",
+}
+
 /**
  * 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) {
+export default function PopoverContentAnchored($props: PopoverContentAnchoredProps) {
+	$props ??= $watch({});
 	$props.side ??= "bottom";
 	$props.alignment ??= "center";
 

package/src/Popover/PopoverContentContextual.torp

@@ -4,11 +4,20 @@ import getScrollParent from "../utils/getScrollParent";
 import setContextPosition from "../utils/setContextPosition";
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverContentContextualProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * 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) {	
+export default function PopoverContentContextual($props: PopoverContentContextualProps) {	
+	$props ??= $watch({});
+
 	let div: HTMLDivElement;
 	let shown = false;
 	let closeOnClick = false;

package/src/Popover/PopoverOverlay.torp

@@ -1,10 +1,19 @@
 import { disableScroll } from "../mount/disableScroll";
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverOverlayProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The background overlay for a Popover. Adding an overlay automatically sets the Popover to modal.
  */
-export default function PopoverOverlay($props: any) {
+export default function PopoverOverlay($props: PopoverOverlayProps) {
+	$props ??= $watch({});
+
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
 	if (!context) {

package/src/Popover/PopoverTrigger.torp

@@ -1,9 +1,18 @@
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The button that causes a Popover to appear or disappear.
  */
-export default function PopoverTrigger($props: any) {
+export default function PopoverTrigger($props: PopoverTriggerProps) {
+	$props ??= $watch({});
+
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
 	if (!context) {

package/src/Popover/PopoverTriggerContextual.torp

@@ -1,9 +1,18 @@
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 
+interface PopoverTriggerContextualProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The element that causes a Popover to appear or disappear when right-clicked.
  */
-export default function PopoverTriggerContextual($props: any) {
+export default function PopoverTriggerContextual($props: PopoverTriggerContextualProps) {
+	$props ??= $watch({});
+
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
 	if (!context) {

package/src/Popover/PopoverTriggerHover.torp

@@ -2,10 +2,19 @@
 import { PopoverContextName, type PopoverContext } from "./PopoverTypes";
 import hoverTrigger from "../mount/hoverTrigger";
 
+interface PopoverTriggerHoverProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The div that causes a Popover to appear or disappear when hovered.
  */
-export default function PopoverTriggerHover($props: any) {
+export default function PopoverTriggerHover($props: PopoverTriggerHoverProps) {
+	$props ??= $watch({});
+
 	// Get stuff out of the PopoverContext
 	const context = $context[PopoverContextName] as PopoverContext;
 	if (!context) {
@@ -13,7 +22,7 @@ export default function PopoverTriggerHover($props: any) {
 	}
 	let $state = context.state;
 
-	function handleHover(node, e) {
+	function handleHover(node: HTMLElement, e: TouchEvent | MouseEvent) {
 		if ($state.position) {
 			// Get the position relative to the element, so we can reposition on scroll
 			const rect = node.getBoundingClientRect();

package/src/TabGroup/TabContent.torp

@@ -1,19 +1,25 @@
 import getId from "../utils/getId";
 import { TabGroupContextName, type TabGroupContext } from "./TabGroupTypes";
 
+interface TabContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * Content for a TabGroup, which can be revealed or hidden by an associated TabTrigger.
- *
- * @prop {string} [id] -- An ID for the TabContent's div container
  */
-export default function TabContent($props: any) {
+export default function TabContent($props: TabContentProps) {
+	$props ??= $watch({});
 	$props.id ||= getId();
 
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
 		throw new Error("TabContent must be contained within a TabGroup");
 	}
-	let $state = $context[TabGroupContextName].registerItem($props.index, $props.value);
+	let $state = context.registerItem($props.index, $props.value);
 
 	// Set the content ID so that it can be used with aria-controls in TabTrigger
 	$state.contentId = $props.id;
@@ -26,7 +32,7 @@ export default function TabContent($props: any) {
 			aria-labelledby={$state.headerId}
 			data-orientation={$props.orientation}
 			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			@if ($state.active) {
 				<slot />