@torpor/ui 0.2.0 → 0.3.0

package/dist/Disclosure/Disclosure.torp

@@ -1,4 +1,17 @@
-import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
+import { DisclosureContextName, type DisclosureContext, type DisclosureState } from "./DisclosureTypes";
+
+interface DisclosureProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the disclosure is expanded and its content visible */
+	expanded?: boolean,
+	/** If set to true, the user cannot interact with this disclosure */
+	disabled?: boolean,
+	/** Raised when the disclosure is opened or closed */
+	ontoggle?: (open: boolean) => void,
+}
 
 /**
  * An interactive header that enables users to reveal or hide an associated section of content.
@@ -9,33 +22,29 @@ import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes
  *
  * ```
  * <Disclosure>
- *     <DisclosureHeader>
- *         <DisclosureTrigger />
- *     </DisclosureHeader>
- *     <DisclosureContent />
+ * 	<DisclosureHeader>
+ * 		<DisclosureTrigger />
+ * 	</DisclosureHeader>
+ * 	<DisclosureContent />
  * </Disclosure>
  * ```
- *
- * @prop {boolean} [expanded] -- Whether the Disclosure is expanded and its content visible
- * @prop {boolean} [disabled] -- If set to true, the user cannot interact with this Disclosure
- * @prop {(boolean) => void} [ontoggle] -- Raised when this item is opened or closed
  */
-export default function Disclosure($props: any) {
-	$props.expanded ??= false;
-	$props.disabled ??= false;
-
+export default function Disclosure($props: DisclosureProps | undefined) {
 	let $state: DisclosureState = $watch({
-		expanded: $props.expanded && $props.expanded !== "false",
-		disabled: $props.disabled,
-		get dataState() {
-			return this.expanded ? "open" : "closed";
-		},
+		expanded: false,
+		disabled: false,
+		headerId: "",
+		contentId: "",
 	});
 
 	// Update $state with $props
 	$run(() => {
-		$state.expanded = $props.expanded && $props.expanded !== "false";
-		$state.disabled = $props.disabled;
+		$state.expanded = $props?.expanded === true ||
+			// @ts-ignore
+			$props?.expanded === "true";
+		$state.disabled = $props?.disabled === true ||
+			// @ts-ignore
+			$props?.disabled === "true";
 	});
 
 	// Put stuff into a DisclosureContext
@@ -47,7 +56,7 @@ export default function Disclosure($props: any) {
 	// Dispatch the toggle event when the value of expanded changes
 	let firstToggle = true;
 	$run(() => {
-		const ev = $props.ontoggle;
+		const ev = $props?.ontoggle;
 		const expanded = $state.expanded;
 		if (firstToggle) {
 			firstToggle = false;
@@ -58,10 +67,10 @@ export default function Disclosure($props: any) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-disclosure-item ${$props.class ?? ""}`.trim()}
-			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			{$props?.id}
+			class={`torp-disclosure-item ${$props?.class ?? ""}`.trim()}
+			data-state={$state.expanded ? "open" : "closed"}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			<slot />
 		</div>

package/dist/Disclosure/DisclosureContent.torp

@@ -1,32 +1,38 @@
 import getId from "../utils/getId";
 import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
 
+interface DisclosureContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this content should act as a region. Set this when the content contains heading elements or a nested Disclosure */
+	ariaRegion?: boolean,
+}
+
 /**
  * Content for a Disclosure, which can be revealed or hidden by an associated DisclosureTrigger.
- *
- * @prop {string} [id] -- An ID for the DisclosureContent's div container
- * @prop {boolean} [ariaRegion] -- Whether this content should act as a region. Set this when the content contains heading elements or a nested Disclosure
  */
-export default function DisclosureContent($props: any) {
-	$props.id ||= getId();
+export default function DisclosureContent($props: DisclosureContentProps | undefined) {
+	let defaultId = getId();
 
 	const context = $context[DisclosureContextName] as DisclosureContext;
 	if (!context) {
 		throw new Error("DisclosureContent must be contained within a Disclosure");
 	}
-	let $state = $context[DisclosureContextName].state
+	let $state = context.state
 
 	// Set the content ID so that it can be used with aria-controls in DisclosureTrigger
-	$state.contentId = $props.id;
+	$state.contentId = $props?.id ?? defaultId;
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-disclosure-content ${$props.class ?? ""}`.trim()}
-			role={$props.ariaRegion ? "region" : undefined}
+			id={$props?.id ?? defaultId}
+			class={`torp-disclosure-content ${$props?.class ?? ""}`.trim()}
+			role={$props?.ariaRegion ? "region" : undefined}
 			aria-labelledby={$state.headerId}
-			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-state={$state.expanded ? "open" : "closed"}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			@if ($state.expanded) {
 				<slot />

package/dist/Disclosure/DisclosureHeader.torp

@@ -1,5 +1,14 @@
 import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
 
+interface DisclosureHeaderProps {
+	/** 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 Disclosure, which contains the DisclosureTrigger.
  *
@@ -7,26 +16,24 @@ import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes
  * 
  * ```
  * <DisclosureHeader>
- *    <DisclosureTrigger />
+ * 	<DisclosureTrigger />
  * </DisclosureHeader>
  * ```
- *
- * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
  */
-export default function DisclosureHeader($props: any) {
+export default function DisclosureHeader($props: DisclosureHeaderProps | undefined) {
 	const context = $context[DisclosureContextName] as DisclosureContext;
 	if (!context) {
 		throw new Error("DisclosureHeader must be contained within a Disclosure");
 	}
-	let $state = $context[DisclosureContextName].state
+	let $state = context.state
 
 	@render {
 		@// TODO: $props.as
 		<h4
-			{$props.id}
-			class={`torp-disclosure-header ${$props.class ?? ""}`.trim()}
-			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			{$props?.id}
+			class={`torp-disclosure-header ${$props?.class ?? ""}`.trim()}
+			data-state={$state.expanded ? "open" : "closed"}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			<slot />
 		</h4>

package/dist/Disclosure/DisclosureTrigger.torp

@@ -1,32 +1,39 @@
 import getId from "../utils/getId";
 import { DisclosureContextName, type DisclosureContext } from "./DisclosureTypes";
 
+interface DisclosureTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * A header button for a Disclosure, which can be used to reveal or hide an associated DisclosureContent.
  */
-export default function DisclosureTrigger() {
-	$props.id ||= getId();
+export default function DisclosureTrigger($props: DisclosureTriggerProps | undefined) {
+	let defaultId = getId();
 
 	// Get stuff out of the DisclosureContext
 	const context = $context[DisclosureContextName] as DisclosureContext;
 	if (!context) {
 		throw new Error("DisclosureTrigger must be contained within a Disclosure");
 	}
-	let $state = $context[DisclosureContextName].state;
+	let $state = context.state;
 
 	// Set the header ID so that it can be used with aria-labelledby in DisclosureContent
-	$state.headerId = $props.id;
+	$state.headerId = $props?.id ?? defaultId;
 
 	@render {
 		<button
 			type="button"
-			{$props.id}
-			class={`torp-disclosure-trigger ${$props.class ?? ""}`.trim()}
-			disabled={$state.disabled || $state.parentDisabled}
+			id={$props?.id ?? defaultId}
+			class={`torp-disclosure-trigger ${$props?.class ?? ""}`.trim()}
+			disabled={$state.disabled}
 			aria-expanded={$state.expanded.toString()}
 			aria-disabled={$state.disabled}
 			aria-controls={$state.contentId}
-			data-state={$state.dataState}
+			data-state={$state.expanded ? "open" : "closed"}
 			data-disabled={$state.disabled}
 			onclick={() => $state.expanded = !$state.expanded}
 		>

package/dist/Disclosure/DisclosureTypes.ts

@@ -10,5 +10,4 @@ export interface DisclosureState {
 	contentId: string;
 	expanded: boolean;
 	disabled: boolean;
-	dataState: "open" | "closed";
 }

package/dist/Disclosure/index.d.ts

@@ -1,72 +1,111 @@
 import { type SlotRender } from "@torpor/view";
 
 
+interface DisclosureProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the disclosure is expanded and its content visible */
+	expanded?: boolean,
+	/** If set to true, the user cannot interact with this disclosure */
+	disabled?: boolean,
+	/** Raised when the disclosure is opened or closed */
+	ontoggle?: (open: boolean) => 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 interactive header that enables users to reveal or hide an associated section of content.
+ *
+ * See [the WAI ARIA guidelines for Disclosures](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/).
+ *
+ * The structure of a Disclosure is:
+ *
+ * ```
+ * <Disclosure>
+ * 	<DisclosureHeader>
+ * 		<DisclosureTrigger />
+ * 	</DisclosureHeader>
+ * 	<DisclosureContent />
+ * </Disclosure>
+ * ```
  */
 declare function Disclosure(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DisclosureProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DisclosureContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this content should act as a region. Set this when the content contains heading elements or a nested Disclosure */
+	ariaRegion?: 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.
+ * Content for a Disclosure, which can be revealed or hidden by an associated DisclosureTrigger.
  */
 declare function DisclosureContent(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DisclosureContentProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DisclosureHeaderProps {
+	/** 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",
+}
+
 /**
- * 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 Disclosure, which contains the DisclosureTrigger.
+ *
+ * The structure of a DisclosureHeader is:
+ * 
+ * ```
+ * <DisclosureHeader>
+ * 	<DisclosureTrigger />
+ * </DisclosureHeader>
+ * ```
  */
 declare function DisclosureHeader(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: DisclosureHeaderProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface DisclosureTriggerProps {
+	/** 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.
+ * A header button for a Disclosure, which can be used to reveal or hide an associated DisclosureContent.
  */
 declare function DisclosureTrigger(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: DisclosureTriggerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;

package/dist/Drawer/Drawer.torp

@@ -1,82 +1,123 @@
+import { DrawerContextName, type DrawerContext, type DrawerState } from "./DrawerTypes";
 
-export default function Drawer($props: any) {
-	$props.visible ??= true;
-	$props.position ||= "left";
+interface DrawerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the drawer is modal. If true, an overlay should be supplied to obscure outside content, and only the drawer content will be visible to screen readers  */
+	modal?: boolean,
+	/** Whether the drawer is visible  */
+	visible?: boolean,
+	/** Which side of the window to show the drawer from */
+	position?: "left" | "right" | "top" | "bottom",
+	/** A function to be called when the user selects a response */
+	callback?: ((value: any) => void),
+	/** Raised when the drawer is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the drawer has opened */
+	onopen?: () => void,
+	/** Raised when the drawer has closed */
+	onclose?: (result: any) => void,
+}
 
-	let offscreen: HTMLElement | undefined;
+/**
+ * A drawer 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/).
+ *
+ * The structure of a Drawer is:
+ *
+ * ```
+ * <Drawer>
+ * 	<DrawerTrigger /> (optional)
+ * 	<DrawerContent />
+ * </Drawer>
+ * ```
+ */
+export default function Drawer($props: DrawerProps | undefined) {
+	let $state: DrawerState = $watch({
+		visible: false,
+		modal: $props?.modal ?? false,
+		position: $props?.position ?? "left",
+	});
 
-	// From https://stackoverflow.com/a/46707458
-	function measure(el, fn) {
-		let oldVisibility = el.style.visibility;
-		let oldPosition = el.style.position;
+	// Sync props and state
+	$run(() => {
+		$state.visible = $props?.visible ?? false;
+	});
+	$run(() => {
+		if ($props !== undefined) {
+			$props.visible = $state.visible;
+		}
+	});
 
-		let oldParent = el.parentNode;
-		let oldBefore = el.nextNode;
+	let result: any;
 
-		el.style.visibility = "hidden";
-		el.style.position = "absolute";
+	// Set the context to pass down to items
+	let context: DrawerContext = {
+		handleButton,
+		handleClickOutside,
+		state: $state,
+	};
+	$context[DrawerContextName] = context;
 
-		document.body.appendChild(el);
-		let result = fn(el);
-		el.parentNode.removeChild(el);
+	// Dispatch the toggle event when the drawer 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;
+			}
+		}
 
-		oldParent.appendChild(el, oldBefore);
-		el.style.visibility = oldVisibility;
-		el.style.position = oldPosition;
+		// Hide the drawer
+		$state.visible = false;
 
-		return result;
+		// Call the callback
+		if ($props?.callback) {
+			$props?.callback(result);
+		}
 	}
 
-	function transitionArgs() {
-		if (offscreen) {
-			switch ($props.position) {
-				case "left": {
-					offscreen.style.left = 0;
-					const width = measure(offscreen, (el) => el.offsetWidth);
-					return [
-						{ transform: `translateX(-${width}px)` },
-						{ transform: "translateX(0px)" }
-					];
-				}
-				case "top": {
-					offscreen.style.top = 0;
-					const height = measure(offscreen, (el) => el.offsetHeight);
-					return [
-						{ transform: `translateY(-${height}px)` },
-						{ transform: "translateY(0px)" }
-					];
-				}
-				case "right": {
-					offscreen.style.right = 0;
-					const width = measure(offscreen, (el) => el.offsetWidth);
-					return [
-						{ transform: `translateX(${width}px)` },
-						{ transform: "translateX(0px)" }
-					];
-				}
-				case "bottom": {
-					offscreen.style.bottom = 0;
-					const height = measure(offscreen, (el) => el.offsetHeight);
-					return [
-						{ transform: `translateY(${height}px)` },
-						{ transform: "translateY(0px)" }
-					];
-				}
-			}
-		}
+	function handleClickOutside(e: MouseEvent) {
+		e.preventDefault();
+		$state.visible = false;
 	}
 
 	@render {
-		@if ($props.visible) {
-			<div
-				{$props.id}
-				class={`torp-offscreen ${$props.class ?? ""}`.trim()}
-				style="position: fixed;"
-				transition={transitionArgs()}
-				&ref={offscreen}
-			>
-				<slot />
-			</div>
-		}
+		<div
+			{$props?.id}
+			class={`torp-drawer ${$props?.class ?? ""}`.trim()}
+		>
+			<slot />
+		</div>
 	}
-}
+}

package/dist/Drawer/DrawerContent.torp

@@ -0,0 +1,80 @@
+import { type Animation } from "@torpor/view";
+import { slide } from "../motion";
+import { addDocumentEvent, removeDocumentEvent } from "../utils/documentEvents";
+import { DrawerContextName, type DrawerContext } from "./DrawerTypes";
+
+interface DrawerContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
+/**
+ * The content that is displayed for a Drawer when it is open.
+ */
+export default function DrawerContent($props: DrawerContentProps | undefined) {
+	let drawer: HTMLElement;
+	let shown = false;
+	let closeOnClick = false;
+
+	// Get stuff out of the DrawerContext
+	const context = $context[DrawerContextName] as DrawerContext;
+	if (!context) {
+		throw new Error("DrawerContent must be contained within a Drawer");
+	}
+	let $state = context.state;
+
+	$run(() => {
+		if (!$state.visible) {
+			hide();
+		}
+	});
+
+	function show() {
+		shown = true;
+
+		// HACK: Because this Drawer 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 &&
+			drawer &&
+			!drawer.contains(e.target as HTMLElement)
+		) {
+			e.preventDefault();
+			context.handleClickOutside!(e);
+		}
+	}
+
+	@render {
+		@if ($state.visible) {
+			<div
+				{$props?.id}
+				class={`torp-drawer-content ${$props?.class ?? ""}`.trim()}
+				style="position: fixed;"
+				transition={(e) => slide(e, { side: $state.position })}
+				&ref={drawer}
+				onmount={show}
+			>
+				<slot />
+			</div>
+		}
+	}
+}