@torpor/ui 0.1.7 → 0.2.1

package/dist/Menu/MenuRadio.torp

@@ -0,0 +1,99 @@
+import {
+	MenuButtonContextName,
+	MenuContextName,
+	MenuRadioGroupContextName,
+	type MenuButtonContext,
+	type MenuContext,
+	type MenuRadioGroupContext
+} from "./MenuTypes";
+
+interface MenuRadioProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value of the item */
+	value?: string,
+	/** Whether this item is checked */
+	checked?: boolean,
+	/** Whether this item is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * A button that is placed in a Menu or MenuGroup to allow the user to select
+ * from a number of options.
+ */
+export default function MenuRadio($props: MenuRadioProps) {
+	$props ??= $watch({});
+
+	let $state = $watch({
+		checked: $props.checked,
+	});
+
+	$run(() => {
+		$props.checked = $state.checked;
+	});
+
+	let button: HTMLButtonElement;
+
+	// Get stuff out of the MenuContext
+	const menuContext = $context[MenuContextName] as MenuContext;
+	if (!menuContext) {
+		throw new Error("MenuRadio must be contained within a Menu");
+	}
+	const { registerItem, handleItemKey, handleItemFocus } = menuContext;
+
+	// Get stuff out of the MenuRadioGroupContext
+	const groupContext = $context[MenuRadioGroupContextName] as MenuRadioGroupContext;
+	if (!groupContext) {
+		throw new Error("MenuRadio must be contained within a MenuRadioGroup");
+	}
+	const { registerItemInGroup, toggleItem } = groupContext;
+
+	// Register this item with the parent Menu
+	const { index } = registerItem(setFocused);
+
+	// Register this item with the parent MenuRadioGroup
+	registerItemInGroup($props.value, setChecked);
+
+	// Set the context to pass down to items
+	let context: MenuButtonContext = {
+		state: $state
+	};
+	$context[MenuButtonContextName] = context;
+
+	function setFocused() {
+		button.focus();
+	}
+
+	function setChecked(value: boolean) {
+		$state.checked = value;
+	}
+
+	function handleClick() {
+		if (!$state.checked) {
+			toggleItem($props.value);
+		}
+	}
+
+	@render {
+		<button
+			{$props.id}
+			class={`torp-menu-radio ${$props.class ?? ""}`.trim()}
+			type="button"
+			{$props.disabled}
+			role="menuitemradio"
+			aria-checked={$props.checked}
+			aria-disabled={$props.disabled ? "true" : undefined}
+			data-state={$props.checked ? "checked" : "unchecked"}
+			data-disabled={$props.disabled ? "true" : undefined}
+			onkeydown={handleItemKey}
+			onclick={handleClick}
+			onfocus={() => handleItemFocus(index)}
+			&ref={button}
+		>
+			<slot />
+		</button>
+	}
+}

package/dist/Menu/MenuRadioGroup.torp

@@ -0,0 +1,97 @@
+import {
+	type MenuRadioGroupContext,
+	MenuRadioGroupContextName,
+	type RadioGroupItemState
+} from "./MenuTypes";
+
+interface MenuRadioGroupProps {
+	/** 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 value of the checked MenuRadio */
+	value?: string | undefined,
+	/** Called when the checked item has changed */
+	onchange?: (value: any) => void,
+}
+
+/**
+ * A container for a logical group of menu RadioGroup items.
+ */
+export default function MenuRadioGroup($props: MenuRadioGroupProps) {
+	$props ??= $watch({});
+
+	// A collection containing the state and some functions for each item
+	let itemStates: RadioGroupItemState[] = [];
+
+	// Set the context to pass down to items
+	let context: MenuRadioGroupContext = {
+		registerItemInGroup,
+		toggleItem
+	};
+	$context[MenuRadioGroupContextName] = context;
+
+	$mount(() => {
+		// Set the initial checked item
+		setValue($props.value);
+	});
+
+	function registerItemInGroup(itemValue: string, setChecked: (value: boolean) => void) {
+		// Add the item"s state to the array
+		const newItemState: RadioGroupItemState = {
+			value: itemValue,
+			checked: false,
+			setChecked
+		};
+		itemStates.push(newItemState);
+		itemStates = itemStates;
+	}
+
+	function setValue(newValue?: string) {
+		// No point doing this if there aren't any items yet (e.g. from the initial setValue() call)
+		if (!itemStates.length) {
+			return;
+		}
+
+		// Ensure the value passed in was a string (in case e.g. the user has set values to ints)
+		newValue = newValue?.toString();
+		for (let item of itemStates) {
+			item.checked = item.value === newValue;
+			item.setChecked(item.checked);
+		}
+
+		// Set the value
+		if ($props.value !== newValue) {
+			$props.value = newValue;
+
+			if ($props.onchange) {
+				$props.onchange($props.value);
+			}
+		}
+	}
+
+	function toggleItem(toggleValue: string) {
+		let newValue = "";
+		for (let item of itemStates) {
+			const checked = item.value === toggleValue;
+			item.setChecked(checked);
+			if (checked) {
+				newValue = item.value;
+			}
+		}
+		$props.value = newValue;
+	}
+
+	@render {
+		<div
+			{$props.id}
+			class={`torp-menu-radio-group ${$props.class ?? ""}`.trim()}
+			role="group"
+			aria-label={$props.ariaLabel}
+		>
+			<slot />
+		</div>
+	}
+}

package/dist/Menu/MenuSeparator.torp

@@ -0,0 +1,24 @@
+
+interface MenuSeparatorProps {
+	/** 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 MenuSeparator($props: MenuSeparatorProps) {
+	$props ??= $watch({});
+
+	@render {
+		<div
+			{$props.id}
+			class={`torp-menu-separator ${$props.class ?? ""}`.trim()}
+			role="separator"
+		>
+			<slot />
+		</div>
+	}
+}

package/dist/Menu/MenuTypes.ts

@@ -0,0 +1,58 @@
+export const MenuContextName = "Menu";
+export const MenuButtonContextName = "MenuButton";
+export const MenuRadioGroupContextName = "MenuRadioGroup";
+export const MenuPopoutContextName = "MenuPopout";
+
+export interface MenuContext {
+	setVisible: (value: boolean, result?: any) => void;
+
+	/** Called from a MenuButton to close the Menu and return a result */
+	handleTrigger: (type: "confirm" | "cancel" | undefined, value?: any) => void;
+
+	/** Called from a MenuButton when its button is focused */
+	handleItemFocus: (index: number) => void;
+
+	/** Called from a MenuButton when a key is pressed */
+	handleItemKey: (e: KeyboardEvent) => void;
+
+	state: {
+		/** Whether the Menu is visible. Writable so that it can be subscribed to by children */
+		visible: boolean;
+	};
+
+	/** The element that caused this Menu to be shown */
+	anchorElement?: HTMLElement;
+
+	/** Called from each MenuButton/Check/Radio to register itself with this Menu */
+	registerItem: (setFocused: () => void) => { index: number };
+}
+
+export interface MenuButtonContext {
+	state: {
+		checked: boolean;
+	};
+}
+
+export interface MenuRadioGroupContext {
+	registerItemInGroup: (value: string, setChecked: (value: boolean) => void) => void;
+	toggleItem: (value: string) => void;
+}
+
+export interface MenuPopoutContext {
+	setVisible: (value: boolean) => void;
+	state: {
+		visible: boolean;
+	};
+	anchorElement?: HTMLElement;
+	focusFirstElement?: () => void;
+}
+
+export interface ItemState {
+	setFocused: () => void;
+}
+
+export interface RadioGroupItemState {
+	value: string;
+	checked: boolean;
+	setChecked: (value: boolean) => void;
+}

package/dist/Menu/index.d.ts

@@ -0,0 +1,293 @@
+import { type SlotRender } from "@torpor/view";
+
+
+interface MenuProps {
+	/** 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,
+}
+
+/**
+ * A list of choices for the user, such as a set of actions or functions. A
+ * menu is usually hidden until made visible by the user.
+ *
+ * See [the WAI ARIA guidelines for Menus](https://www.w3.org/WAI/ARIA/apg/patterns/menu/).
+ *
+ * The structure of a Menu is:
+ *
+ * ```
+ * <Menu>
+ *     <MenuButton />
+ *     <MenuSeparator /> (optional)
+ *     <MenuGroup> (optional)
+ *         <MenuButton />
+ *     </MenuGroup>
+ * </Menu>
+ * ```
+ */
+declare function Menu(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuButtonProps {
+	/** 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,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * A button that is placed in a Menu or MenuGroup and signals a response by a user.
+ *
+ */
+declare function MenuButton(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuButtonProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuCheckProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this item is checked */
+	checked?: boolean,
+	/** Whether this item is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * A button that is placed in a Menu or MenuGroup to allow the user to turn an
+ * option on or off.
+ *
+ */
+declare function MenuCheck(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuCheckProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuGroupProps {
+	/** 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 menu items.
+ */
+declare function MenuGroup(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuGroupProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuIndicatorProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether this item is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * An indicator for a MenuCheck or MenuRadio component, which is displayed
+ * when the value of checked is true.
+ */
+declare function MenuIndicator(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuIndicatorProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuPopoutProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** Whether the popout is visible */
+	visible?: boolean,
+	/** Called when the popout is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Called when the popout has opened */
+	onopen?: () => void,
+	/** Called when the popout has closed */
+	onclose?: () => void,
+}
+
+/**
+ * A popout that is attached to a menu button and can be used to show a submenu.
+ *
+ * The structure of a MenuPopout is:
+ *
+ * ```
+ * <MenuPopout>
+ *     <MenuPopoutTrigger /> (optional)
+ * 	<MenuPopoutContent />
+ * </MenuPopout>
+ * ```
+ */
+declare function MenuPopout(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuPopoutProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuPopoutContentProps {
+	/** 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 MenuPopout when it is open.
+ */
+declare function MenuPopoutContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuPopoutContentProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuPopoutTriggerProps {
+	/** 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 Menu or MenuGroup and signals a response by a user.
+ */
+declare function MenuPopoutTrigger(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuPopoutTriggerProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuRadioProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Class name(s) for the root element */
+	class?: string,
+	/** The value of the item */
+	value?: string,
+	/** Whether this item is checked */
+	checked?: boolean,
+	/** Whether this item is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * A button that is placed in a Menu or MenuGroup to allow the user to select
+ * from a number of options.
+ */
+declare function MenuRadio(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuRadioProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuRadioGroupProps {
+	/** 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 value of the checked MenuRadio */
+	value?: string | undefined,
+	/** Called when the checked item has changed */
+	onchange?: (value: any) => void,
+}
+
+/**
+ * A container for a logical group of menu RadioGroup items.
+ */
+declare function MenuRadioGroup(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuRadioGroupProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface MenuSeparatorProps {
+	/** 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.
+ */
+declare function MenuSeparator(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: MenuSeparatorProps,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { Menu, MenuButton, MenuCheck, MenuGroup, MenuIndicator, MenuPopout, MenuPopoutContent, MenuPopoutTrigger, MenuRadio, MenuRadioGroup, MenuSeparator };

package/dist/Menu/index.js

@@ -0,0 +1,46 @@
+// src/Menu/Menu.torp
+import Menu_default from "./Menu.torp";
+
+// src/Menu/MenuButton.torp
+import MenuButton_default from "./MenuButton.torp";
+
+// src/Menu/MenuCheck.torp
+import MenuCheck_default from "./MenuCheck.torp";
+
+// src/Menu/MenuGroup.torp
+import MenuGroup_default from "./MenuGroup.torp";
+
+// src/Menu/MenuIndicator.torp
+import MenuIndicator_default from "./MenuIndicator.torp";
+
+// src/Menu/MenuPopout.torp
+import MenuPopout_default from "./MenuPopout.torp";
+
+// src/Menu/MenuPopoutContent.torp
+import MenuPopoutContent_default from "./MenuPopoutContent.torp";
+
+// src/Menu/MenuPopoutTrigger.torp
+import MenuPopoutTrigger_default from "./MenuPopoutTrigger.torp";
+
+// src/Menu/MenuRadio.torp
+import MenuRadio_default from "./MenuRadio.torp";
+
+// src/Menu/MenuRadioGroup.torp
+import MenuRadioGroup_default from "./MenuRadioGroup.torp";
+
+// src/Menu/MenuSeparator.torp
+import MenuSeparator_default from "./MenuSeparator.torp";
+export {
+  Menu_default as Menu,
+  MenuButton_default as MenuButton,
+  MenuCheck_default as MenuCheck,
+  MenuGroup_default as MenuGroup,
+  MenuIndicator_default as MenuIndicator,
+  MenuPopout_default as MenuPopout,
+  MenuPopoutContent_default as MenuPopoutContent,
+  MenuPopoutTrigger_default as MenuPopoutTrigger,
+  MenuRadio_default as MenuRadio,
+  MenuRadioGroup_default as MenuRadioGroup,
+  MenuSeparator_default as MenuSeparator
+};
+//# sourceMappingURL=index.js.map

package/dist/Menu/index.js.map

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