@torpor/ui 0.2.0 → 0.3.0

package/dist/Contextual/index.d.ts

@@ -0,0 +1,90 @@
+import { type SlotRender } from "@torpor/view";
+
+
+interface ContextualProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the contextual is modal. If true, an overlay should be supplied to obscure outside content, and only the context content will be visible to screen readers  */
+	modal?: boolean,
+	/** Whether the contextual is visible  */
+	visible?: boolean,
+	/** The element to anchor this contextual to, as an alternative to supplying a ContextualTrigger  */
+	anchor?: HTMLElement,
+	/** The position to display this contextual at  */
+	position?: Point,
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when this contextual is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the contextual has opened */
+	onopen?: () => void,
+	/** Raised when the contextual has closed */
+	onclose?: (result: any) => void,
+}
+
+/**
+ * A contextual window that is shown to the user at the cursor's location.
+ *
+ * The structure of a Contextual is:
+ *
+ * ```
+ * <Contextual>
+ * 	<ContextualTrigger /> (optional)
+ * 	<ContextualContent />
+ * </Contextual>
+ * ```
+ */
+declare function Contextual(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ContextualProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ContextualContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The content that is displayed for a Contextual when it is open, displayed at the
+ * position that the user right-clicked.
+ */
+declare function ContextualContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ContextualContentProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ContextualTriggerProps {
+	/** 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 element that causes a Contextual to appear or disappear when right-clicked.
+ */
+declare function ContextualTrigger(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ContextualTriggerProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { Contextual, ContextualContent, ContextualTrigger };

package/dist/Contextual/index.js

@@ -0,0 +1,14 @@
+// src/Contextual/Contextual.torp
+import Contextual_default from "./Contextual.torp";
+
+// src/Contextual/ContextualContent.torp
+import ContextualContent_default from "./ContextualContent.torp";
+
+// src/Contextual/ContextualTrigger.torp
+import ContextualTrigger_default from "./ContextualTrigger.torp";
+export {
+  Contextual_default as Contextual,
+  ContextualContent_default as ContextualContent,
+  ContextualTrigger_default as ContextualTrigger
+};
+//# sourceMappingURL=index.js.map

package/dist/Contextual/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/Dialog/Dialog.torp

@@ -1,11 +1,24 @@
 import getId from "../utils/getId";
-import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
 import { trapFocus, type TrapFocusOptions } from "../mount/trapFocus";
-import { PopoverContextName, type PopoverContext } from "../Popover/PopoverTypes";
-import { DialogContextName, type DialogContext, type DialogState } from "./DialogTypes";
+import { ModalContextName, type ModalContext } from "../Modal/ModalTypes";
+import { PopoverContextName } from "../Popover/PopoverTypes";
+import { DialogContextName, type DialogContext, type DialogState, type HandleButtonPress } from "./DialogTypes";
+
+interface DialogProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the popover to screen readers  */
+	ariaLabel?: string,
+	/** Whether the dialog should alert the user via the screen reader */
+	alert?: boolean,
+}
 
 /**
- * Content for a window displayed in a Popover.
+ * A dialog that can be used to show a message to the user, or get information from the user.
+ * 
+ * Dialogs are typically shown within a Modal or Popover.
  * 
  * See [the WAI ARIA guidelines for Dialogs](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/).
  * 
@@ -13,43 +26,44 @@ import { DialogContextName, type DialogContext, type DialogState } from "./Dialo
  * 
  * ```
  * <Dialog>
- *     <DialogHeader /> (optional)
- *     <DialogBody /> (optional)
- *     <DialogFooter> (optional)
- *         <DialogButton /> (optional)
- *     </DialogFooter>
+ * 	<ModalOverlay /> (optional -- will set `modal` to true)
+ * 	<DialogHeader /> (optional)
+ * 	<DialogBody /> (optional)
+ * 	<DialogFooter> (optional)
+ * 		<DialogButton /> (optional)
+ * 	</DialogFooter>
  * </Dialog>
  * ```
  * 
- * @prop {string | undefined} ariaLabel -- An ARIA label for describing the popover to screen readers 
- * @prop {boolean} alert -- Whether the dialog should alert the user via the screen reader
  */
-export default function Dialog($props: any) {
-	$props.id ??= getId();
-	$props.dialog ??= false;
+export default function Dialog($props: DialogProps | undefined) {
+	let defaultId = getId();
 
-	let div: HTMLDivElement;
+	//let div: HTMLDivElement;
 
 	let trapFocusOptions: TrapFocusOptions = {
 		focusableElements: []
 	};
 
-	// Get stuff out of the PopoverContext
-	const popoverContext = $context[PopoverContextName] as PopoverContext;
-	if (!popoverContext) {
-		throw new Error("Dialog must be contained within a Popover");
-	}
-	const { handleButton, modal } = popoverContext;
-	const visible = popoverContext.state.visible;
+	// Maybe get stuff out of a Modal context
+	let modal = false;
+	let visible = true;
+	let handleButton: HandleButtonPress | undefined = undefined;
+	const modalContext = $context[ModalContextName] ?? $context[PopoverContextName] as ModalContext;
+	if (modalContext) {
+		modal = true;
+		visible = modalContext.state.visible;
+		handleButton = modalContext.handleButton;
 
-	popoverContext.handleClickOutside = handleClickOutside;
-	// Set the focusFirstElement method in the PopoverContext so that it can be
-	// called after everything has been shown
-	popoverContext.focusFirstElement = focusFirstElement;
+		modalContext.handleClickOutside = handleClickOutside;
+		// Set the focusFirstElement method in the ModalContext so that it can be
+		// called after everything has been shown
+		modalContext.focusFirstElement = focusFirstElement;
+	}
 
 	// Set the IDs for using in the Dialog's ARIA attributes
 	let $state: DialogState = $watch({
-		dialogId: $props.id,
+		dialogId: $props?.id ?? defaultId,
 		headerId: "",
 		bodyId: "",
 		visible
@@ -59,60 +73,22 @@ export default function Dialog($props: any) {
 	let context: DialogContext = {
 		handleButton,
 		state: $state,
-		anchorElement: popoverContext.anchorElement
+		anchorElement: modalContext ? modalContext.anchorElement : undefined
 	};
 	$context[DialogContextName] = context;
 
-	let closeOnClick = false;
-
-	$mount(() => {
-		if ($state.visible) {
-			// HACK: Because this Dialog 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. I guess we could
-			// require the user to preventDefault after calling showPrompt etc,
-			// but that seems very error-prone?
-			closeOnClick = false;
-			addDocumentEvent("mousedown", handleDocumentMouseDown);
-			addDocumentEvent("click", handleDocumentClick);
-		} else {
-			removeDocumentEvent("mousedown", handleDocumentMouseDown);
-			removeDocumentEvent("click", handleDocumentClick);
-			// Focus the anchor element per WAI guidelines
-			if (context.anchorElement?.focus) {
-				context.anchorElement.focus();
-			}
-		}
-	});
-
 	function focusFirstElement() {
 		if (trapFocusOptions.focusableElements.length) {
 			trapFocusOptions.focusableElements[0].focus();
 		}
 	}
 
-	function handleDocumentMouseDown() {
-		closeOnClick = true;
-	}
-
-	function handleDocumentClick(e: MouseEvent) {
-		if (
-			closeOnClick &&
-			div &&
-			!div.contains(e.target as HTMLElement) &&
-			(!context.anchorElement || !context.anchorElement.contains(e.target as HTMLElement))
-		) {
-			handleClickOutside(e);
-		}
-	}
-
 	function handleClickOutside(e: MouseEvent) {
 		// Don't allow the user to click outside -- they must press a button or
 		// the Esc key
 		e.preventDefault();
 		if (!modal) {
-			popoverContext.state.visible = false;
-			context.state.visible = false;
+			modalContext.state.visible = false;
 		}
 	}
 
@@ -138,17 +114,17 @@ export default function Dialog($props: any) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-dialog ${$props.class ?? ""}`.trim()}
+			id={$props?.id ?? defaultId}
+			class={`torp-dialog ${$props?.class ?? ""}`.trim()}
 			tabindex="0"
-			role={$props.alert ? "alertdialog" : "dialog"}
+			role={$props?.alert === true ? "alertdialog" : "dialog"}
 			aria-modal={modal}
-			aria-label={$props.ariaLabel}
-			aria-labelledby={!$props.ariaLabel && $state.headerId ? $state.headerId : undefined}
+			aria-label={$props?.ariaLabel}
+			aria-labelledby={!$props?.ariaLabel && $state.headerId ? $state.headerId : undefined}
 			aria-describedby={$state.bodyId ? $state.bodyId : undefined}
 			onkeydown={handleKey}
 			onmount={(el) => trapFocus(el, trapFocusOptions)}
-			&ref={div}
+			@//&ref={div}
 		>
 			<slot />
 		</div>

package/dist/Dialog/DialogBody.torp

@@ -1,15 +1,21 @@
 import getId from "../utils/getId";
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogBodyProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the body content will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: boolean,
+}
+
 /**
  * The body information for a Dialog. Content in the body will be announced by
  * screen readers when the Dialog is opened, unless ariaAnnounce is false.
- * 
- * @prop {boolean} ariaAnnounce -- Whether the body content will be announced by screen readers when the Dialog is opened
  */
-export default function DialogBody($props: any) {
-	$props.id ??= getId();
-	$props.ariaAnnounce ??= true;
+export default function DialogBody($props: DialogBodyProps | undefined) {
+	let defaultId = getId();
 
 	// Get stuff out of the DialogContext
 	const context = $context[DialogContextName] as DialogContext;
@@ -19,14 +25,14 @@ export default function DialogBody($props: any) {
 	let $state = context.state;
 
 	// Set the body id for using in the Dialog's ARIA attributes
-	if ($props.ariaAnnounce) {
-		$state.bodyId = $props.id;
+	if ($props?.ariaAnnounce !== false) {
+		$state.bodyId = $props?.id || defaultId;
 	}
 
 	@render {
 		<div
-			{$props.id} 
-			class={`torp-dialog-body ${$props.class ?? ""}`.trim()}
+			id={$props?.id ?? defaultId} 
+			class={`torp-dialog-body ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/dist/Dialog/DialogButton.torp

@@ -1,13 +1,25 @@
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogButtonProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value that should be returned when this button is pressed and the Dialog was invoked by calling showContextual, showPrompt or showPopover */
+	value?: any,
+	/** "confirm" if the button should respond to the Enter key or "cancel" if the button should respond to the Escape key */
+	type?: "confirm" | "cancel",
+	/** Whether this button is disabled */
+	disabled?: boolean,
+	/** Raised when the button is clicked */
+	onclick?: (e: MouseEvent) => void,
+}
+
 /**
  * A button that is placed in a DialogFooter and signals a response by a user.
  * 
- * @prop {any | undefined} value -- The value that should be returned when this button is pressed and the Dialog was invoked by calling showContextual, showPrompt or showPopover
- * @prop {"confirm" | "cancel" | undefined} type -- "confirm" if the button should respond to the Enter key or "cancel" if the button should respond to the Escape key
- * @prop {boolean} disabled -- Whether this button is disabled
  */
-export default function DialogButton($props: any) {
+export default function DialogButton($props: DialogButtonProps | undefined) {
 	let button: HTMLButtonElement;
 
 	// Get stuff out of the DialogContext
@@ -19,26 +31,28 @@ export default function DialogButton($props: any) {
 
 	$mount(() => {
 		// Store the confirm or cancel button in the DialogContext
-		if ($props.type === "confirm") {
+		if ($props?.type === "confirm") {
 			context.confirmButton = button;
-		} else if ($props.type === "cancel") {
+		} else if ($props?.type === "cancel") {
 			context.cancelButton = button;
 		}
 	});
 
-	function handleClick(e) {
-		if ($props.onclick) {
-			$props.onclick(e)
+	function handleClick(e: MouseEvent) {
+		if ($props?.onclick) {
+			$props?.onclick(e)
+		}
+		if (handleButton) {
+			handleButton($props?.type, $props?.value);
 		}
-		handleButton($props.type, $props.value);
 	}
 
 	@render {
 		<button
 			type="button"
-			{$props.id}
-			class={`torp-dialog-button ${$props.class ?? ""}`.trim()}
-			disabled={$props.disabled}
+			{$props?.id}
+			class={`torp-dialog-button ${$props?.class ?? ""}`.trim()}
+			disabled={$props?.disabled}
 			onclick={handleClick}
 			&ref={button}
 		>

package/dist/Dialog/DialogFooter.torp

@@ -1,11 +1,19 @@
+
+interface DialogFooterProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * The footer for a Dialog, which may contain one or more DialogButtons.
  */
-export default function DialogFooter($props: any) {
+export default function DialogFooter($props: DialogFooterProps | undefined) {
 	@render {
 		<div
-			{$props.id}
-			class={`torp-dialog-footer ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-dialog-footer ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/dist/Dialog/DialogHeader.torp

@@ -1,15 +1,22 @@
 import getId from "../utils/getId";
 import { DialogContextName, type DialogContext } from "./DialogTypes";
 
+interface DialogHeaderProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the header will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: boolean,
+}
+
 /**
  * The header for a Dialog. Content in the header will be announced by screen
  * readers when the Dialog is opened, unless ariaAnnounce is false.
  * 
- * @prop {boolean} ariaAnnounce -- Whether the header will be announced by screen readers when the Dialog is opened
  */
-export default function DialogHeader($props: any) {
-	$props.id ??= getId();
-	$props.ariaAnnounce ??= true;
+export default function DialogHeader($props: DialogHeaderProps | undefined) {
+	let defaultId = getId();
 
 	// Get stuff out of the DialogContext
 	const context = $context[DialogContextName] as DialogContext;
@@ -19,14 +26,14 @@ export default function DialogHeader($props: any) {
 	let $state = context.state;
 
 	// Set the header id for using in the Dialog's ARIA attributes
-	if ($props.ariaAnnounce) {
-		$state.headerId = $props.id;
+	if ($props?.ariaAnnounce !== false) {
+		$state.headerId = $props?.id ?? defaultId;
 	}
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-dialog-footer ${$props.class ?? ""}`.trim()}
+			id={$props?.id ?? defaultId}
+			class={`torp-dialog-footer ${$props?.class ?? ""}`.trim()}
 		>
 			<slot />
 		</div>

package/dist/Dialog/DialogTypes.ts

@@ -1,7 +1,9 @@
 export const DialogContextName = "Dialog";
 
+export type HandleButtonPress = (type: "confirm" | "cancel" | undefined, value?: any) => void;
+
 export interface DialogContext {
-	handleButton: (type: "confirm" | "cancel" | undefined, value?: any) => void;
+	handleButton?: HandleButtonPress;
 	state: DialogState;
 	anchorElement?: HTMLElement;
 	confirmButton?: HTMLButtonElement;
@@ -12,5 +14,4 @@ export interface DialogState {
 	dialogId: string;
 	headerId: string;
 	bodyId: string;
-	visible: boolean;
 }

package/dist/Dialog/index.d.ts

@@ -1,90 +1,138 @@
 import { type SlotRender } from "@torpor/view";
 
 
+interface DialogProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the popover to screen readers  */
+	ariaLabel?: string,
+	/** Whether the dialog should alert the user via the screen reader */
+	alert?: 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 dialog that can be used to show a message to the user, or get information from the user.
+ * 
+ * Dialogs are typically shown within a Modal or Popover.
+ * 
+ * See [the WAI ARIA guidelines for Dialogs](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/).
+ * 
+ * The structure of a Dialog is:
+ * 
+ * ```
+ * <Dialog>
+ * 	<ModalOverlay /> (optional -- will set `modal` to true)
+ * 	<DialogHeader /> (optional)
+ * 	<DialogBody /> (optional)
+ * 	<DialogFooter> (optional)
+ * 		<DialogButton /> (optional)
+ * 	</DialogFooter>
+ * </Dialog>
+ * ```
+ * 
  */
 declare function Dialog(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DialogProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DialogBodyProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the body content will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: 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.
+ * The body information for a Dialog. Content in the body will be announced by
+ * screen readers when the Dialog is opened, unless ariaAnnounce is false.
  */
 declare function DialogBody(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DialogBodyProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DialogButtonProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value that should be returned when this button is pressed and the Dialog was invoked by calling showContextual, showPrompt or showPopover */
+	value?: any,
+	/** "confirm" if the button should respond to the Enter key or "cancel" if the button should respond to the Escape key */
+	type?: "confirm" | "cancel",
+	/** Whether this button is disabled */
+	disabled?: boolean,
+	/** Raised when the button is clicked */
+	onclick?: (e: MouseEvent) => 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 button that is placed in a DialogFooter and signals a response by a user.
+ * 
  */
 declare function DialogButton(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DialogButtonProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DialogFooterProps {
+	/** 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 footer for a Dialog, which may contain one or more DialogButtons.
  */
 declare function DialogFooter(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DialogFooterProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DialogHeaderProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the header will be announced by screen readers when the Dialog is opened */
+	ariaAnnounce?: 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.
+ * The header for a Dialog. Content in the header will be announced by screen
+ * readers when the Dialog is opened, unless ariaAnnounce is false.
+ * 
  */
 declare function DialogHeader(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DialogHeaderProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;