@boreal-ui/types 0.1.426 → 0.2.0

package/dist/types/types/types.d.ts

@@ -0,0 +1,208 @@
+import type { ComponentType, SVGProps } from "react";
+
+/** A framework-neutral SVG icon component accepted by Boreal UI components. */
+export type IconComponent = ComponentType<SVGProps<SVGSVGElement>>;
+
+/**
+ * Represents a named color scheme used for theming components.
+ */
+export interface ColorScheme {
+  /** The unique name of the color scheme. */
+  name: string;
+  /** The primary brand or accent color. */
+  primaryColor: string;
+  /** The secondary brand or accent color. */
+  secondaryColor: string;
+  /** A tertiary accent color. */
+  tertiaryColor: string;
+  /** A quaternary accent or background support color. */
+  quaternaryColor: string;
+  /** The base background color for surfaces using this scheme. */
+  backgroundColor: string;
+  /** Optional override for text color to ensure contrast (e.g., force white text on dark themes). */
+  forceTextColor?: string;
+}
+
+/**
+ * Visual theme options used to style components.
+ */
+export type ThemeType =
+  | "primary"
+  | "p"
+  | "secondary"
+  | "s"
+  | "tertiary"
+  | "t"
+  | "quaternary"
+  | "q"
+  | "clear"
+  | "c";
+
+/**
+ * UI state indicators typically used for validation or status feedback.
+ */
+export type StateType =
+  | "success"
+  | "error"
+  | "warning"
+  | "info"
+  | "disabled"
+  | "";
+
+/**
+ * Types of notifications that determine visual appearance or icon.
+ */
+export type NotificationType =
+  | "general"
+  | "success"
+  | "error"
+  | "warning"
+  | "info";
+
+/**
+ * Predefined sizing scale for components.
+ */
+export type SizeType =
+  | "xs"
+  | "small"
+  | "sm"
+  | "medium"
+  | "md"
+  | "large"
+  | "lg"
+  | "xl";
+
+/**
+ * Orientation of components or layout elements.
+ */
+export type OrientationType = "horizontal" | "h" | "vertical" | "v";
+
+/**
+ * Shadow depth for component elevation and emphasis.
+ */
+export type ShadowType =
+  | "none"
+  | "light"
+  | "lt"
+  | "sm"
+  | "medium"
+  | "md"
+  | "strong"
+  | "str"
+  | "lg"
+  | "intense"
+  | "xl";
+
+/**
+ * Border radius values used for rounding component corners.
+ */
+export type RoundingType =
+  | "none"
+  | "small"
+  | "sm"
+  | "medium"
+  | "md"
+  | "large"
+  | "lg";
+
+/** Border radius values for controls and surfaces that support pill or circular shapes. */
+export type RoundableRoundingType = RoundingType | "full";
+
+/** Common surface treatments, including the composable glass-and-outline treatment. */
+export type VariantType = "solid" | "outline" | "glass" | "glassOutline";
+
+/** Common placement values for floating UI and edge-attached surfaces. */
+export type PlacementType = "top" | "bottom" | "left" | "right";
+
+/** Direction-aware content alignment. */
+export type AlignmentType = "start" | "center" | "end";
+
+/**
+ * Border width values used for component borders.
+ */
+export type BorderType =
+  | "none"
+  | "xs"
+  | "small"
+  | "sm"
+  | "medium"
+  | "md"
+  | "large"
+  | "lg"
+  | "xl";
+
+/**
+ * Anchor position typically used for tooltips, badges, or floating elements.
+ */
+export type PositionType =
+  | "topLeft"
+  | "tl"
+  | "topCenter"
+  | "tc"
+  | "topRight"
+  | "tr"
+  | "bottomLeft"
+  | "bl"
+  | "bottomCenter"
+  | "bc"
+  | "bottomRight"
+  | "br";
+
+/**
+ * Shape type used for avatars, buttons, badges, etc.
+ */
+export type ShapeType = "circle" | "rounded" | "square";
+
+/**
+ * Status type used to represent presence or activity.
+ */
+export type StatusType = "online" | "offline" | "busy" | "away" | "custom";
+
+/**
+ * Position of the status indicator relative to the parent element (e.g., avatar).
+ */
+export type StatusPositionType =
+  | "topLeft"
+  | "tl"
+  | "topRight"
+  | "tr"
+  | "bottomLeft"
+  | "bl"
+  | "bottomRight"
+  | "br";
+
+/**
+ * How a component should attach to the viewport or page layout.
+ */
+export type AttachmentType = "static" | "st" | "fixed" | "fx" | "sticky" | "sk";
+
+export type TitlePositionType =
+  | "top"
+  | "t"
+  | "bottom"
+  | "b"
+  | "left"
+  | "l"
+  | "right"
+  | "r"
+  | "overlay";
+export type LabelPositionType =
+  | "top"
+  | "t"
+  | "bottom"
+  | "b"
+  | "left"
+  | "l"
+  | "right"
+  | "r";
+
+/**
+ * Props for interactive components that require user input or actions.
+ */
+export type InteractiveProps = {
+  onClick?: React.MouseEventHandler;
+  onKeyDown?: React.KeyboardEventHandler;
+  onKeyUp?: React.KeyboardEventHandler;
+  tabIndex?: number;
+  role?: string;
+};

package/dist/types/utils/eventHandlers.d.ts

@@ -0,0 +1,7 @@
+import type { SyntheticEvent } from "react";
+export type ReactEventHandler<Event extends SyntheticEvent> = (event: Event) => void;
+/**
+ * Runs a consumer handler before Boreal's corresponding default interaction.
+ * Consumers can cancel the internal behavior with `event.preventDefault()`.
+ */
+export declare function composeEventHandlers<Event extends SyntheticEvent>(consumerHandler?: ReactEventHandler<Event>, internalHandler?: ReactEventHandler<Event>): ReactEventHandler<Event> | undefined;

package/dist/types/utils/eventHandlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventHandlers.d.ts","sourceRoot":"","sources":["../../../src/utils/eventHandlers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAE5C,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,cAAc,IAAI,CAC5D,KAAK,EAAE,KAAK,KACT,IAAI,CAAC;AAEV;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,SAAS,cAAc,EAC/D,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAC1C,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC,GACzC,iBAAiB,CAAC,KAAK,CAAC,GAAG,SAAS,CAQtC"}

package/dist/types/utils/floatingPanelGeometry.d.ts

@@ -0,0 +1,36 @@
+export type FloatingPanelRect = Pick<DOMRect, "top" | "right" | "bottom" | "left" | "width" | "height">;
+export type FloatingPanelViewport = {
+    width: number;
+    height: number;
+};
+export type FloatingPanelCoordinates = {
+    x: number;
+    y: number;
+};
+export type NestedPanelLayout = {
+    placement: "left" | "right";
+    offsetY: number;
+};
+export declare const readFloatingPanelViewport: () => FloatingPanelViewport;
+export declare const getFloatingPanelSizeLimits: (viewport: FloatingPanelViewport, padding: number, minimumWidth?: number, minimumHeight?: number) => {
+    maxWidth: number;
+    maxHeight: number;
+};
+export declare const clampFloatingPanelCoordinates: ({ requested, panelWidth, panelHeight, viewport, padding, }: {
+    requested: FloatingPanelCoordinates;
+    panelWidth: number;
+    panelHeight: number;
+    viewport: FloatingPanelViewport;
+    padding: number;
+}) => FloatingPanelCoordinates;
+export declare const getFloatingPanelHorizontalOverflow: (rect: FloatingPanelRect, viewportWidth: number, padding: number) => {
+    overflowLeft: boolean;
+    overflowRight: boolean;
+};
+export declare const resolveNestedPanelLayout: ({ panelRect, anchorRect, panelWidth, viewport, padding, }: {
+    panelRect: FloatingPanelRect;
+    anchorRect?: FloatingPanelRect;
+    panelWidth: number;
+    viewport: FloatingPanelViewport;
+    padding: number;
+}) => NestedPanelLayout;

package/dist/types/utils/floatingPanelGeometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"floatingPanelGeometry.d.ts","sourceRoot":"","sources":["../../../src/utils/floatingPanelGeometry.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,OAAO,EACP,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CACzD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,yBAAyB,QAAO,qBAiB5C,CAAC;AAEF,eAAO,MAAM,0BAA0B,GACrC,UAAU,qBAAqB,EAC/B,SAAS,MAAM,EACf,qBAAkB,EAClB,sBAAmB;;;CAInB,CAAC;AAEH,eAAO,MAAM,6BAA6B,GAAI,4DAM3C;IACD,SAAS,EAAE,wBAAwB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB,KAAG,wBASF,CAAC;AAEH,eAAO,MAAM,kCAAkC,GAC7C,MAAM,iBAAiB,EACvB,eAAe,MAAM,EACrB,SAAS,MAAM;;;CAIf,CAAC;AAEH,eAAO,MAAM,wBAAwB,GAAI,2DAMtC;IACD,SAAS,EAAE,iBAAiB,CAAC;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB,KAAG,iBAoBH,CAAC"}

package/dist/types/utils/menuNavigation.d.ts

@@ -4,3 +4,35 @@ export declare const getMenuItemPath: (parentPath: string, index: number) => str
 export declare const getParentMenuPath: (path: string) => string | null;
 export declare const isMenuPathOpen: (openPath: string | null, path: string) => boolean;
 export declare const isDisabledMenuElement: (element: HTMLElement) => boolean;
+export declare const getWrappedMenuIndex: (index: number, itemCount: number) => number;
+export type MenuNavigationIntent = {
+    type: "none";
+} | {
+    type: "dismiss";
+} | {
+    type: "tab-dismiss";
+} | {
+    type: "focus";
+    index: number;
+} | {
+    type: "open-submenu";
+} | {
+    type: "close-submenu";
+} | {
+    type: "activate";
+};
+type ResolveMenuNavigationIntentOptions = {
+    key: string;
+    currentIndex: number;
+    itemCount: number;
+    activeHasSubmenu: boolean;
+    activeItemAvailable: boolean;
+    isSubmenuPanel: boolean;
+};
+/**
+ * Resolves vertical menu keyboard input without reading or mutating the DOM.
+ * The owning component remains responsible for focus, submenu state, and
+ * dismissal side effects.
+ */
+export declare const resolveMenuNavigationIntent: ({ key, currentIndex, itemCount, activeHasSubmenu, activeItemAvailable, isSubmenuPanel, }: ResolveMenuNavigationIntentOptions) => MenuNavigationIntent;
+export {};

package/dist/types/utils/menuNavigation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"menuNavigation.d.ts","sourceRoot":"","sources":["../../../src/utils/menuNavigation.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAC3C,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC,eAAO,MAAM,eAAe,GAAI,YAAY,MAAM,EAAE,OAAO,MAAM,WACb,CAAC;AAErD,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,IAGzD,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,GAAG,IAAI,EAAE,MAAM,MAAM,YACJ,CAAC;AAEjE,eAAO,MAAM,qBAAqB,GAAI,SAAS,WAAW,YAEE,CAAC"}
+{"version":3,"file":"menuNavigation.d.ts","sourceRoot":"","sources":["../../../src/utils/menuNavigation.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAC3C,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC,eAAO,MAAM,eAAe,GAAI,YAAY,MAAM,EAAE,OAAO,MAAM,WACb,CAAC;AAErD,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,IAGzD,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,GAAG,IAAI,EAAE,MAAM,MAAM,YACJ,CAAC;AAEjE,eAAO,MAAM,qBAAqB,GAAI,SAAS,WAAW,YAEE,CAAC;AAE7D,eAAO,MAAM,mBAAmB,GAAI,OAAO,MAAM,EAAE,WAAW,MAAM,WACd,CAAC;AAEvD,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,GACzB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC;AAEzB,KAAK,kCAAkC,GAAG;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GAAI,0FAOzC,kCAAkC,KAAG,oBAwCvC,CAAC"}

package/dist/types/utils/modalLayerManager.d.ts

@@ -0,0 +1,10 @@
+export type ModalLayerId = symbol;
+export interface ModalLayerOptions {
+    getLayerElement: () => HTMLElement | null;
+    getFocusScope: () => HTMLElement | null;
+    onEscape?: () => void;
+    restoreFocus?: boolean;
+}
+export declare const getFocusableElements: (scope: HTMLElement) => HTMLElement[];
+export declare const registerModalLayer: (id: ModalLayerId, options: ModalLayerOptions) => () => void;
+export declare const __resetModalLayerManagerForTests: () => void;

package/dist/types/utils/modalLayerManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modalLayerManager.d.ts","sourceRoot":"","sources":["../../../src/utils/modalLayerManager.ts"],"names":[],"mappings":"AAcA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IAC1C,aAAa,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AA8BD,eAAO,MAAM,oBAAoB,GAAI,OAAO,WAAW,KAAG,WAAW,EAGlE,CAAC;AAmKJ,eAAO,MAAM,kBAAkB,GAC7B,IAAI,YAAY,EAChB,SAAS,iBAAiB,eA8C3B,CAAC;AAEF,eAAO,MAAM,gCAAgC,YAY5C,CAAC"}

package/dist/types/utils/navigationSecurity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"navigationSecurity.d.ts","sourceRoot":"","sources":["../../../src/utils/navigationSecurity.ts"],"names":[],"mappings":"AAUA,wBAAgB,sBAAsB,CACpC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GACnB,MAAM,GAAG,SAAS,CAgBpB;AAED,wBAAgB,YAAY,CAC1B,MAAM,CAAC,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAqBpB"}
+{"version":3,"file":"navigationSecurity.d.ts","sourceRoot":"","sources":["../../../src/utils/navigationSecurity.ts"],"names":[],"mappings":"AAUA,wBAAgB,sBAAsB,CACpC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GACnB,MAAM,GAAG,SAAS,CAgBpB;AAED,wBAAgB,YAAY,CAC1B,MAAM,CAAC,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CA0BpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boreal-ui/types",
-  "version": "0.1.426",
+  "version": "0.2.0",
   "readme": "README.md",
   "description": "Shared TypeScript declarations for Boreal UI core and Next.js packages.",
   "keywords": [