@torpor/ui 0.2.0 → 0.3.0

package/src/TabGroup/TabContent.torp

@@ -1,32 +1,41 @@
 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,
+	/** The index of this item */
+	index?: number,
+	/** The value for this item */
+	value?: 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) {
-	$props.id ||= getId();
+export default function TabContent($props: TabContentProps | undefined) {
+	let defaultId = 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;
+	$state.contentId = $props?.id ?? defaultId;
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-tab-content ${$props.class ?? ""}`.trim()}
+			id={$props?.id ?? defaultId}
+			class={`torp-tab-content ${$props?.class ?? ""}`.trim()}
 			role="tabpanel"
 			aria-labelledby={$state.headerId}
-			data-orientation={$props.orientation}
-			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-orientation={context.orientation}
+			data-state={$state.active ? "active" : "inactive"}
+			data-disabled={$state.disabled ? "true" : undefined}
 		>
 			@if ($state.active) {
 				<slot />

package/src/TabGroup/TabGroup.torp

@@ -1,5 +1,22 @@
 import { TabGroupContextName, type TabGroupContext, type ItemState } from "./TabGroupTypes";
 
+interface TabGroupProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The orientation of the tab buttons, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+	/** How tabs are activated; if automatic they are shown on focus, if manual they must be clicked */
+	activation?: "automatic" | "manual",
+	/** The value of the active TabContent */
+	value?: string,
+	/** If set to true, the user cannot interact with any items in the TabGroup */
+	disabled?: boolean,
+	/** Raised when the active item has changed */
+	onchange?: (value: string | string[]) => void
+}
+
 /**
  * A list of interactive headings coupled with layered sections of content that
  * enable users to reveal a single section of content at a time.
@@ -18,17 +35,24 @@ import { TabGroupContextName, type TabGroupContext, type ItemState } from "./Tab
  * 	<TabContent />
  * </TabGroup>
  * ```
- *
- * @prop {"horizontal" | "vertical"} orientation -- The orientation of the tab buttons, which affects keyboard navigation
- * @prop {"automatic" | "manual"} activation -- How tabs are activated; if automatic they are shown on focus, if manual they must be clicked
- * @prop {string | string[]} value -- The value of the active TabContent
- * @prop {boolean} disabled -- If set to true, the user cannot interact with any items in the TabGroup
- * @prop {(value: string | string[]) => void} [onchange] -- Raised when the active item has changed
  */
-export default function TabGroup($props: any) {
-	$props.orientation ||= "horizontal";
-	$props.activation ||= "automatic";
-	$props.value ||= "";
+export default function TabGroup($props: TabGroupProps | undefined) {
+	let orientation = $props?.orientation ?? "horizontal";
+	let activation = $props?.activation ?? "automatic";
+
+	let $state = $watch({
+		value: ""
+	});
+
+	// Sync props and state
+	$run(() => {
+		$state.value = $props?.value ?? "";
+	});
+	$run(() => {
+		if ($props !== undefined) {
+			$props.value = $state.value;
+		}
+	});
 
 	let itemStates: ItemState[] = [];
 
@@ -43,45 +67,39 @@ export default function TabGroup($props: any) {
 		removeItem,
 		triggerItem,
 		handleHeaderKey,
-		orientation: $props.orientation,
-		activation: $props.activation,
+		orientation,
+		activation,
 	};
 	$context[TabGroupContextName] = context;
 
 	$run(() => {
-		// HACK: This should probably be done with setters?
-		let newValue = $props.value;
-
 		// Ensure the value passed in was a string (in case e.g. the user has set values to ints)
-		newValue = newValue?.toString();
+		$state.value = $state.value.toString();
 		for (let item of itemStates) {
-			item.active = item.value === newValue;
+			item.active = item.value === $state.value;
 		}
-
-		// Set the value
-		$props.value = newValue;
 	});
 
 	$run(() => {
-		itemStates.forEach((s) => s.parentDisabled = $props.disabled);
+		itemStates.forEach((s) => s.parentDisabled = $props?.disabled === true);
 	});
 
 	// Dispatch the change event when the value changes
 	let firstChange = true;
 	$run(() => {
-		const ev = $props.onchange;
-		const value = $props.value;
+		const ev = $props?.onchange;
+		const value = $props?.value;
 		if (firstChange) {
 			firstChange = false;
 		} else if (ev) {
-			ev(value);
+			ev(value!);
 		}
 	});
 
 	// On mount, if no value was set, show the first tab content
 	$mount(() => {
-		if ($props.value === "" && itemStates.length) {
-			$props.value = itemStates[0].value;
+		if ($state.value === "" && itemStates.length) {
+			$state.value = itemStates[0].value;
 		}
 	});
 
@@ -101,7 +119,7 @@ export default function TabGroup($props: any) {
 
 	function registerItem(index: number | undefined, value: string | undefined): ItemState {
 		// If an index wasn't set for the item, set it automatically
-		if (!index) {
+		if (index === undefined) {
 			index = nextItemIndex++;
 		}
 
@@ -118,7 +136,7 @@ export default function TabGroup($props: any) {
 		}
 
 		// If a value wasn't set for the item, set it to the index
-		if (!value) {
+		if (value === undefined) {
 			value = index.toString();
 		}
 
@@ -127,8 +145,8 @@ export default function TabGroup($props: any) {
 			index,
 			value,
 			// TODO: this would be better than using $mount, but it doesn't work with nested tabs
-			// active: value === $props.value || ($props.value === "" && index === 0),
-			active: value === $props.value,
+			// active: value === $props?.value || ($props?.value === "" && index === 0),
+			active: value === $state.value,
 			headerId: "",
 			contentId: "",
 			disabled: false,
@@ -137,8 +155,8 @@ export default function TabGroup($props: any) {
 				return this.active ? "active" : "inactive";
 			},
 			setFocused: () => {},
-			orientation: $props.orientation,
-			activation: $props.activation
+			orientation,
+			activation
 		});
 		itemStates.splice(index, 0, newItemState);
 
@@ -159,7 +177,7 @@ export default function TabGroup($props: any) {
 		for (let item of itemStates) {
 			// The item is active if it has the supplied value
 			if (item.value === toggleValue) {
-				$props.value = item.value;
+				$state.value = item.value;
 				break;
 			}
 		}
@@ -169,7 +187,7 @@ export default function TabGroup($props: any) {
 		switch (e.key) {
 			case "Left":
 			case "ArrowLeft": {
-				if ($props.orientation === "horizontal" && headerIndex > 0) {
+				if (orientation === "horizontal" && headerIndex > 0) {
 					e.preventDefault();
 					itemStates[headerIndex - 1].setFocused();
 				}
@@ -177,7 +195,7 @@ export default function TabGroup($props: any) {
 			}
 			case "Up":
 			case "ArrowUp": {
-				if ($props.orientation === "vertical" && headerIndex > 0) {
+				if (orientation === "vertical" && headerIndex > 0) {
 					e.preventDefault();
 					itemStates[headerIndex - 1].setFocused();
 				}
@@ -185,7 +203,7 @@ export default function TabGroup($props: any) {
 			}
 			case "Right":
 			case "ArrowRight": {
-				if ($props.orientation === "horizontal" && headerIndex < itemStates.length - 1) {
+				if (orientation === "horizontal" && headerIndex < itemStates.length - 1) {
 					e.preventDefault();
 					itemStates[headerIndex + 1].setFocused();
 				}
@@ -193,7 +211,7 @@ export default function TabGroup($props: any) {
 			}
 			case "Down":
 			case "ArrowDown": {
-				if ($props.orientation === "vertical" && headerIndex < itemStates.length - 1) {
+				if (orientation === "vertical" && headerIndex < itemStates.length - 1) {
 					e.preventDefault();
 					itemStates[headerIndex + 1].setFocused();
 				}
@@ -218,9 +236,9 @@ export default function TabGroup($props: any) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-tab-group ${$props.class ?? ""}`.trim()}
-			data-orientation={$props.orientation}
+			{$props?.id}
+			class={`torp-tab-group ${$props?.class ?? ""}`.trim()}
+			data-orientation={$props?.orientation}
 		>
 			<slot />
 		</div>

package/src/TabGroup/TabGroupTypes.ts

@@ -3,9 +3,13 @@ export const TabItemContextName = "TabItem";
 
 export interface TabGroupContext {
 	/** Called from a header when it is added */
-	registerHeader: (index: number, value: string, setFocused: () => void) => ItemState;
+	registerHeader: (
+		index: number | undefined,
+		value: string | undefined,
+		setFocused: () => void,
+	) => ItemState;
 	/** Called from an item when it is added */
-	registerItem: (index: number, value: string) => ItemState;
+	registerItem: (index: number | undefined, value: string | undefined) => ItemState;
 	/** Called from an item when it is removed */
 	removeItem: (index: number) => void;
 	/** Called from an item when it is triggered */
@@ -17,12 +21,14 @@ export interface TabGroupContext {
 }
 
 export interface TabItemContext {
-	/** Called when an item is triggered */
+	/** Raised when an item is triggered */
 	triggerItem: (value: string) => void;
-	/** Called when a TabHeader receives a keyboard event */
+	/** Raised when a TabHeader receives a keyboard event */
 	handleHeaderKey: (index: number, e: KeyboardEvent) => void;
 	/** The reactive state for an item */
 	state: ItemState;
+	orientation: "horizontal" | "vertical";
+	activation: "automatic" | "manual";
 }
 
 export interface ItemState {
@@ -33,7 +39,6 @@ export interface ItemState {
 	contentId: string;
 	disabled: boolean;
 	parentDisabled: boolean;
-	dataState: "active" | "inactive";
 	/** Called in the TabGroup when a header needs to be focused */
 	setFocused: () => void;
 }

package/src/TabGroup/TabHeader.torp

@@ -1,5 +1,18 @@
 import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from "./TabGroupTypes";
 
+interface TabHeaderProps {
+	/** 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 index of this header's item */
+	index?: number,
+	/** The value for this header's item */
+	value?: string,
+}
+
 /**
  * The header for a tab item, which contains the TabTrigger.
  *
@@ -10,20 +23,22 @@ import { TabGroupContextName, TabItemContextName, type TabGroupContext, type Tab
  * 	<TabTrigger />
  * </TabHeader>
  * ```
- *
- * @prop {"h1" | "h2" | "h3" | "h4" | "h5" | "h6"} as -- The type of HTML header to use
  */
-export default function TabHeader($props: any) {
+export default function TabHeader($props: TabHeaderProps | undefined) {
+	let button: HTMLButtonElement;
+
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
 		throw new Error("TabHeader must be contained within a TabGroup");
 	}
-	let $state = $context[TabGroupContextName].registerHeader($props.index, $props.value);
+	let $state = context.registerHeader($props?.index, $props?.value);
 
 	const itemContext: TabItemContext = {
 		triggerItem: context.triggerItem,
 		handleHeaderKey: context.handleHeaderKey,
 		state: $state,
+		orientation: context.orientation,
+		activation: context.activation
 	};
 	$context[TabItemContextName] = itemContext;
 
@@ -35,16 +50,17 @@ export default function TabHeader($props: any) {
 	});
 
 	@render {
-		@// TODO: $props.as
+		@// TODO: $props?.as
 		<h4
-			{$props.id}
+			{$props?.id}
 			class={[
 				"torp-tab-header",
-				$props.class,
-				$state.orientation
+				$props?.class,
+				context.orientation
 			]}
-			data-state={$state.dataState}
-			data-disabled={$state.dataDisabled}
+			data-state={$state.active ? "active" : "inactive"}
+			data-disabled={$state.disabled ? "true" : undefined}
+			&ref={button}
 		>
 			<slot />
 		</h4>

package/src/TabGroup/TabList.torp

@@ -1,4 +1,13 @@
-import { TabGroupContextName, TabItemContextName, type TabGroupContext, type TabItemContext } from "./TabGroupTypes";
+import { TabGroupContextName, type TabGroupContext } from "./TabGroupTypes";
+
+interface TabListProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** An ARIA label for describing the tab list to screen readers */
+	ariaLabel?: string,
+}
 
 /**
  * A component that holds the TabHeaders of a TabGroup.
@@ -12,10 +21,8 @@ import { TabGroupContextName, TabItemContextName, type TabGroupContext, type Tab
  * 	</TabHeader>
  * </TabList>
  * ```
- *
- * @prop {string} ariaLabel -- An ARIA label for describing the tab list to screen readers
  */
-export default function TabList($props: any) {
+export default function TabList($props: TabListProps | undefined) {
 	// Get stuff out of the TabGroupContext
 	const context = $context[TabGroupContextName] as TabGroupContext;
 	if (!context) {
@@ -35,10 +42,10 @@ export default function TabList($props: any) {
 
 	@render {
 		<div
-			{$props.id}
-			class={`torp-tab-list ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-tab-list ${$props?.class ?? ""}`.trim()}
 			role="tablist"
-			aria-label={$props.ariaLabel}
+			aria-label={$props?.ariaLabel}
 			aria-orientation={orientation}
 			data-orientation={orientation}
 			tabindex="0"

package/src/TabGroup/TabTrigger.torp

@@ -1,23 +1,30 @@
 import getId from "../utils/getId";
 import { TabItemContextName, type TabItemContext } from "./TabGroupTypes";
 
+interface TabTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+}
+
 /**
  * A header button for a tab item, which can be used to reveal an associated TabContent.
  */
-export default function TabTrigger() {
-	let button: HTMLButtonElement;
+export default function TabTrigger($props: TabTriggerProps | undefined) {
+	let defaultId = getId();
 
-	$props.id ||= getId();
+	let button: HTMLButtonElement;
 
 	// Get stuff out of the TabItemContext
 	const context = $context[TabItemContextName] as TabItemContext;
 	if (!context) {
 		throw new Error("TabTrigger must be contained within a TabHeader");
 	}
-	let $state = $context[TabItemContextName].state;
+	let $state = context.state;
 
 	// Set the header ID so that it can be used with aria-labelledby in TabContent
-	$state.headerId = $props.id;
+	$state.headerId = $props?.id ?? defaultId;
 
 	// Let the item know how to set the button's focus
 	$state.setFocused = setFocused;
@@ -25,7 +32,7 @@ export default function TabTrigger() {
 	// This function is called by the parent TabGroup to focus this item's button
 	function setFocused() {
 		button.focus();
-		if ($state.activation === "automatic") {
+		if (context.activation === "automatic") {
 			context.triggerItem($state.value);
 		}
 	}
@@ -44,17 +51,17 @@ export default function TabTrigger() {
 	@render {
 		<button
 			type="button"
-			{$props.id}
-			class={`torp-tab-trigger ${$props.class ?? ""}`.trim()}
+			id={$props?.id ?? defaultId}
+			class={`torp-tab-trigger ${$props?.class ?? ""}`.trim()}
 			role="tab"
 			tabindex="-1"
 			disabled={$state.disabled || $state.parentDisabled}
 			aria-selected={$state.active.toString()}
 			aria-disabled={$state.disabled}
 			aria-controls={$state.contentId}
-			data-state={$state.dataState}
+			data-state={$state.active ? "active" : "inactive"}
 			data-disabled={$state.disabled}
-			data-orientation={$state.orientation}
+			data-orientation={context.orientation}
 			&ref={button}
 			onclick={handleClick}
 			onkeydown={handleKey}

package/src/icons/ArrowDown.torp

@@ -1,8 +1,10 @@
-export default function ArrowDown() {
+import { type IconProps } from "./IconTypes";
+
+export default function ArrowDown($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ArrowLeft.torp

@@ -1,8 +1,10 @@
-export default function ArrowLeft() {
+import { type IconProps } from "./IconTypes";
+
+export default function ArrowLeft($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ArrowRight.torp

@@ -1,8 +1,10 @@
-export default function ArrowRight() {
+import { type IconProps } from "./IconTypes";
+
+export default function ArrowRight($props: IconProps | any) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ArrowUp.torp

@@ -1,8 +1,10 @@
-export default function ArrowUp() {
+import { type IconProps } from "./IconTypes";
+
+export default function ArrowUp($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/Bars.torp

@@ -1,8 +1,10 @@
-export default function Bars() {
+import { type IconProps } from "./IconTypes";
+
+export default function Bars($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/Check.torp

@@ -1,8 +1,10 @@
-export default function Check() {
+import { type IconProps } from "./IconTypes";
+
+export default function Check($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ChevronDown.torp

@@ -1,8 +1,10 @@
-export default function ChevronDown() {
+import { type IconProps } from "./IconTypes";
+
+export default function ChevronDown($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ChevronLeft.torp

@@ -1,8 +1,10 @@
-export default function ChevronLeft() {
+import { type IconProps } from "./IconTypes";
+
+export default function ChevronLeft($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ChevronRight.torp

@@ -1,8 +1,10 @@
-export default function ChevronRight() {
+import { type IconProps } from "./IconTypes";
+
+export default function ChevronRight($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/ChevronUp.torp

@@ -1,8 +1,10 @@
-export default function ChevronUp() {
+import { type IconProps } from "./IconTypes";
+
+export default function ChevronUp($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/Cross.torp

@@ -1,8 +1,10 @@
-export default function Cross() {
+import { type IconProps } from "./IconTypes";
+
+export default function Cross($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="12"

package/src/icons/IconTypes.ts

@@ -0,0 +1,6 @@
+export interface IconProps {
+	/** An ID for the svg element */
+	id?: string;
+	/** Class name(s) for the svg element */
+	class?: string;
+}

package/src/icons/Loading.torp

@@ -1,8 +1,10 @@
-export default function Loading() {
+import { type IconProps } from "./IconTypes";
+
+export default function Loading($props: IconProps | undefined) {
 	@render {
 		<svg
-			{$props.id}
-			class={`torp-icon ${$props.class ?? ""}`.trim()}
+			{$props?.id}
+			class={`torp-icon ${$props?.class ?? ""}`.trim()}
 			viewBox="0 0 100 100"
 			stroke-linejoin="round"
 			stroke-width="20"