@torpor/ui 0.3.7 → 0.4.0

package/dist/ToolBar/index.d.ts

@@ -0,0 +1,212 @@
+import { type SlotRender } from "@torpor/view";
+
+
+interface ToolBarProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** An ARIA label for describing the menu to screen readers  */
+	ariaLabel?: string | undefined,
+	/** The orientation of the menu, which affects keyboard navigation */
+	orientation?: "horizontal" | "vertical",
+}
+
+/**
+ * A toolbar is a container for grouping a set of controls, such as buttons, menubuttons, or checkboxes.
+ *
+ * See [the WAI ARIA guidelines for ToolBars](https://www.w3.org/WAI/ARIA/apg/patterns/toolbar/).
+ *
+ * The structure of a ToolBar is:
+ *
+ * ```
+ * <ToolBar>
+ *	 <ToolBarButton />
+ *	 <ToolBarSeparator /> (optional)
+ *	 <ToolBarPopout /> (optional)
+ *	 ...
+ * </ToolBar>
+ * ```
+ */
+declare function ToolBar(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarButtonProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** Whether this button is disabled  */
+	disabled?: boolean,
+	/** Raised when the button is clicked */
+	onclick?: (e: MouseEvent) => void,
+	/** Raised when a key is pressed down */
+	onkeydown?: (e: KeyboardEvent) => void,
+}
+
+/**
+ * A button that is placed in a ToolBar.
+ *
+ */
+declare function ToolBarButton(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarButtonProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarElementProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** Whether this button is disabled  */
+	disabled?: boolean,
+	/** An element that can be focused via keyboard navigation */
+	element?: HTMLElement,
+}
+
+/**
+ * An element of any type that can be placed in a ToolBar.
+ *
+ */
+declare function ToolBarElement(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarElementProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarPopoutProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** Whether the popout is visible */
+	visible?: boolean,
+	/** Raised when the popout is opened or closed */
+	ontoggle?: (open: boolean) => void,
+	/** Raised when the popout has opened */
+	onopen?: () => void,
+	/** Raised when the popout has closed */
+	onclose?: (result: any) => void,
+}
+
+/**
+ * A popout that is attached to a menu button and can be used to show a submenu.
+ *
+ * The structure of a ToolBarPopout is:
+ *
+ * ```
+ * <ToolBarPopout>
+ * 	<ToolBarPopoutTrigger />
+ * 	<ToolBarPopoutContent />
+ * </ToolBarPopout>
+ * ```
+ */
+declare function ToolBarPopout(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarPopoutProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarPopoutContentProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** 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 ToolBarPopout when it is open.
+ *
+ */
+declare function ToolBarPopoutContent(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarPopoutContentProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarPopoutTriggerProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+	/** The delay before showing the popout, in milliseconds */
+	hoverDelay?: number,
+	/** Whether this button is disabled */
+	disabled?: boolean,
+}
+
+/**
+ * A button that is placed in a ToolBar and signals a response by a user.
+ *
+ */
+declare function ToolBarPopoutTrigger(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarPopoutTriggerProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+
+
+interface ToolBarSeparatorProps {
+	/** An ID for the root element */
+	id?: string;
+	/** Classes for the root element */
+	class?: ClassValue,
+	/** Styles for the root element */
+	style?: StyleValue,
+}
+
+/**
+ * An element in a menu that separates logical sets of menu items.
+ */
+declare function ToolBarSeparator(
+	$parent: ParentNode,
+	$anchor: Node | null,
+	$props: ToolBarSeparatorProps | undefined,
+	$context?: Record<PropertyKey, any>,
+	$slots?: Record<string, SlotRender>,
+): void;
+
+export { ToolBar, ToolBarButton, ToolBarElement, ToolBarPopout, ToolBarPopoutContent, ToolBarPopoutTrigger, ToolBarSeparator };

package/dist/ToolBar/index.js

@@ -0,0 +1,30 @@
+// src/ToolBar/ToolBar.torp
+import ToolBar_default from "./ToolBar.torp";
+
+// src/ToolBar/ToolBarButton.torp
+import ToolBarButton_default from "./ToolBarButton.torp";
+
+// src/ToolBar/ToolBarElement.torp
+import ToolBarElement_default from "./ToolBarElement.torp";
+
+// src/ToolBar/ToolBarPopout.torp
+import ToolBarPopout_default from "./ToolBarPopout.torp";
+
+// src/ToolBar/ToolBarPopoutContent.torp
+import ToolBarPopoutContent_default from "./ToolBarPopoutContent.torp";
+
+// src/ToolBar/ToolBarPopoutTrigger.torp
+import ToolBarPopoutTrigger_default from "./ToolBarPopoutTrigger.torp";
+
+// src/ToolBar/ToolBarSeparator.torp
+import ToolBarSeparator_default from "./ToolBarSeparator.torp";
+export {
+  ToolBar_default as ToolBar,
+  ToolBarButton_default as ToolBarButton,
+  ToolBarElement_default as ToolBarElement,
+  ToolBarPopout_default as ToolBarPopout,
+  ToolBarPopoutContent_default as ToolBarPopoutContent,
+  ToolBarPopoutTrigger_default as ToolBarPopoutTrigger,
+  ToolBarSeparator_default as ToolBarSeparator
+};
+//# sourceMappingURL=index.js.map

package/dist/ToolBar/index.js.map

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