@torpor/ui 0.2.0 → 0.3.0

package/dist/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/dist/TabGroup/index.d.ts

@@ -1,90 +1,156 @@
 import { type SlotRender } from "@torpor/view";
 
 
+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,
+}
+
 /**
- * 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 TabGroup, which can be revealed or hidden by an associated TabTrigger.
  */
 declare function TabContent(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: TabContentProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+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
+}
+
 /**
- * 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 list of interactive headings coupled with layered sections of content that
+ * enable users to reveal a single section of content at a time.
+ *
+ * See [the WAI ARIA guidelines for Tabs](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/).
+ *
+ * The structure of a TabGroup is:
+ *
+ * ```
+ * <TabGroup>
+ * 	<TabList>
+ * 		<TabHeader>
+ * 			<TabTrigger />
+ * 		</TabHeader>
+ * 	</TabList>
+ * 	<TabContent />
+ * </TabGroup>
+ * ```
  */
 declare function TabGroup(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: TabGroupProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+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,
+}
+
 /**
- * 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 tab item, which contains the TabTrigger.
+ *
+ * The structure of a TabHeader is:
+ * 
+ * ```
+ * <TabHeader>
+ * 	<TabTrigger />
+ * </TabHeader>
+ * ```
  */
 declare function TabHeader(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: TabHeaderProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+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,
+}
+
 /**
- * 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 component that holds the TabHeaders of a TabGroup.
+ * 
+ * The structure of a TabList is:
+ * 
+ * ```
+ * <TabList>
+ * 	<TabHeader>
+ * 		<TabTrigger />
+ * 	</TabHeader>
+ * </TabList>
+ * ```
  */
 declare function TabList(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props: any,
+	$props: TabListProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;
 
 
 
+interface TabTriggerProps {
+	/** 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 tab item, which can be used to reveal an associated TabContent.
  */
 declare function TabTrigger(
 	$parent: ParentNode,
 	$anchor: Node | null,
-	$props?: Record<PropertyKey, any>,
+	$props: TabTriggerProps | undefined,
 	$context?: Record<PropertyKey, any>,
 	$slots?: Record<string, SlotRender>,
 ): void;

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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"

package/dist/icons/Minus.torp

@@ -1,8 +1,10 @@
-export default function Minus() {
+import { type IconProps } from "./IconTypes";
+
+export default function Minus($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/dist/icons/Plus.torp

@@ -1,8 +1,10 @@
-export default function Plus() {
+import { type IconProps } from "./IconTypes";
+
+export default function Plus($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"