react-zeugma 4.1.1 → 5.1.0

package/dist/index.d.cts

@@ -1,217 +1,53 @@
-import React, { Dispatch, SetStateAction, RefObject, ReactNode } from 'react';
+import { P as PortalRegistryValue, Z as ZeugmaActionsValue, a as ZeugmaInternalStateValue, b as ZeugmaStateValue, U as UseZeugmaOptions, c as ZeugmaController, d as ZeugmaContextValue, e as ZeugmaProps, S as SplitDirection, T as TreeNode, f as SplitNode } from './types-CaiXD2pG.cjs';
+export { g as PaneNode, h as TabDetails, i as ZeugmaClassNames, j as ZeugmaInternalController } from './types-CaiXD2pG.cjs';
+import * as React from 'react';
+import React__default, { ReactNode } from 'react';
 
-type SplitDirection = 'row' | 'column';
-interface SplitNode {
-    type: 'split';
-    direction: SplitDirection;
-    first: TreeNode;
-    second: TreeNode;
-    splitPercentage: number;
-}
-interface PaneNode {
-    type: 'pane';
-    id: string;
-    tabs: string[];
-    activeTabId: string;
-    locked?: boolean;
-    tabsMetadata?: Record<string, Record<string, unknown>>;
-}
-type TreeNode = SplitNode | PaneNode;
+declare const DEFAULT_SNAP_THRESHOLD = 8;
+declare const DEFAULT_DRAG_ACTIVATION_DISTANCE = 8;
+declare const DEFAULT_RESIZER_SIZE = 4;
 
-interface UseZeugmaOptions {
-    /** Initial layout tree model defining pane organization for uncontrolled mode. Only used on initial mount. */
-    initialLayout?: TreeNode | null;
-    /** Controlled layout tree model. If provided, the hook will run in controlled mode and sync with this value. */
-    layout?: TreeNode | null;
-    /** Callback triggered when the layout changes via drag-and-drop actions, splits, swaps, or resizes. */
-    onChange?: (newLayout: TreeNode | null) => void;
-    /** The ID of the pane that is currently taking up the full dashboard area. Null if no pane is fullscreen. */
-    fullscreenPaneId?: string | null;
-    /** Callback triggered when a pane is toggled to/from fullscreen mode. Passes the active fullscreen paneId or null. */
-    onFullscreenChange?: (paneId: string | null) => void;
-    /** Whether the layout is locked. When locked, resizing, dragging, and dropping are disabled. */
-    locked?: boolean;
-    /** Minimum pixel distance that a user must drag a pane handle before dragging triggers. Defaults to 8. */
-    dragActivationDistance?: number;
-    /** Threshold value in pixels for snapping layout resizing handles to adjacent edges. Defaults to 8. */
-    snapThreshold?: number;
-    /** Minimum split percentage allowed when resizing split panes. Defaults to 5. */
-    minSplitPercentage?: number;
-    /** Maximum split percentage allowed when resizing split panes. Defaults to 95. */
-    maxSplitPercentage?: number;
-    /** Whether dragging a pane far enough outside the container triggers a drag-out/dismiss action. Defaults to false. */
-    enableDragToDismiss?: boolean;
-    /** The threshold in pixels beyond the container boundaries required to activate the drag-out/dismiss action. Defaults to 60. */
-    dismissThreshold?: number;
-    /** Callback triggered when a pane is removed from the dashboard layout tree. */
-    onRemove?: (paneId: string) => void;
-    /** Callback triggered when dragging starts for a pane. */
-    onDragStart?: (activeId: string) => void;
-    /** Callback triggered when dragging ends, providing details on target pane and drop action (split or swap). */
-    onDragEnd?: (activeId: string, overId: string | null, dropAction: {
-        type: 'split' | 'swap';
-        direction?: SplitDirection;
-        position?: 'top' | 'bottom' | 'left' | 'right' | 'center';
-    } | null) => void;
-    /** Callback triggered when the user starts dragging a resizing handle between split panes. */
-    onResizeStart?: (currentNode: SplitNode) => void;
-    /** Callback triggered continuously while the user is dragging a resizing handle. Passes the new split percentage. */
-    onResize?: (currentNode: SplitNode, percentage: number) => void;
-    /** Callback triggered when the user stops dragging a resizing handle. Passes the final split percentage. */
-    onResizeEnd?: (currentNode: SplitNode, percentage: number) => void;
-    /** Callback triggered when the drag-out/dismiss intent changes. */
-    onDismissIntentChange?: (paneId: string | null) => void;
-}
-interface ZeugmaController {
-    layout: TreeNode | null;
-    setLayout: Dispatch<SetStateAction<TreeNode | null>>;
-    fullscreenPaneId: string | null;
-    setFullscreenPaneId: (paneId: string | null) => void;
-    locked: boolean;
-    setLocked: Dispatch<SetStateAction<boolean>>;
-    activeId: string | null;
-    setActiveId: Dispatch<SetStateAction<string | null>>;
-    activeType: 'pane' | 'tab' | null;
-    setActiveType: Dispatch<SetStateAction<'pane' | 'tab' | null>>;
-    dismissIntentId: string | null;
-    setDismissIntentId: Dispatch<SetStateAction<string | null>>;
-    containerRef: RefObject<HTMLElement | null>;
-    setContainerRef: (element: HTMLElement | null) => void;
-    dragActivationDistance: number;
-    snapThreshold: number;
-    minSplitPercentage: number;
-    maxSplitPercentage: number;
-    enableDragToDismiss: boolean;
-    dismissThreshold: number;
-    onRemove?: (paneId: string) => void;
-    onDragStart?: (activeId: string) => void;
-    onDragEnd?: (activeId: string, overId: string | null, dropAction: {
-        type: 'split' | 'swap';
-        direction?: SplitDirection;
-        position?: 'top' | 'bottom' | 'left' | 'right' | 'center';
-    } | null) => void;
-    onResizeStart?: (currentNode: SplitNode) => void;
-    onResize?: (currentNode: SplitNode, percentage: number) => void;
-    onResizeEnd?: (currentNode: SplitNode, percentage: number) => void;
-    onDismissIntentChange?: (paneId: string | null) => void;
-    removePane: (paneId: string) => void;
-    addPane: (paneId: string) => void;
-    splitPane: (targetId: string, direction: SplitDirection, splitType: 'left' | 'right' | 'top' | 'bottom', paneToAdd: string) => void;
-    updateSplitPercentage: (currentNode: SplitNode, percentage: number) => void;
-    updateTabMetadata: (tabId: string, updater: (current: Record<string, unknown> | undefined) => Record<string, unknown> | undefined) => void;
-    updatePaneLock: (paneId: string, locked: boolean) => void;
-    selectTab: (paneId: string, tabId: string) => void;
-    mergeTab: (draggedTabId: string, targetPaneId: string) => void;
-    moveTab: (draggedTabId: string, targetTabId: string, position?: 'before' | 'after') => void;
-    removeTab: (tabId: string) => void;
-}
-interface ZeugmaClassNames {
-    /** CSS class applied to the outer container div of each `<Pane>`. */
-    pane?: string;
-    /** CSS class applied to the pane container when locked. */
-    paneLocked?: string;
-    /** CSS class applied to drop zone indicators when hovering over layout edges to split a pane. */
-    dropPreview?: string;
-    /** CSS class applied to the custom cursor-following drag preview portal wrapper. */
-    dragOverlay?: string;
-    /** CSS class applied to the drag-to-resize split bar handles. */
-    resizer?: string;
-    /** CSS class applied to the background dismiss zone indicator during a drag-out dismiss gesture. */
-    dismissPreview?: string;
-    /** CSS class applied to root container when dashboard is globally locked. */
-    dashboardLocked?: string;
-    /** CSS class applied to drop zone indicator when hovering over a locked pane. */
-    lockedPreview?: string;
-}
-interface ZeugmaProps extends ZeugmaController {
-    /** Render function mapping unique pane IDs to React elements. Usually renders a <Pane> wrapper. */
-    renderPane: (paneId: string) => ReactNode;
-    /** Custom overlay renderer function used to customize the cursor-following drag preview for an active pane or tab. */
-    renderDragOverlay?: (activeId: string, type: 'pane' | 'tab') => ReactNode;
-    /** Optional CSS class name mapping overrides for custom styles of components like panes, drop/swap previews, overlays, etc. */
-    classNames?: ZeugmaClassNames;
-    /** Render function mapping tab IDs to React elements. Used to render tab widgets inside portals. */
-    renderWidget?: (tabId: string) => ReactNode;
-    /** Child nodes nested inside the Zeugma context, usually containing a <PaneTree> or similar layout viewer. */
-    children: ReactNode;
-}
 /**
- * State context — holds reactive values that change during runtime.
- * All consumers of this context will re-render when any of these values change.
- */
-interface ZeugmaStateValue {
-    /** The current active layout tree structure, or null if empty. */
-    layout: TreeNode | null;
-    /** Callback to update the layout tree. */
-    onLayoutChange: (newLayout: TreeNode | null, localOnly?: boolean) => void;
-    /** Renders the inner content of a pane given its unique ID. */
-    renderPane: (paneId: string) => ReactNode;
-    /** The ID of the pane currently being dragged, or null. */
-    activeId: string | null;
-    /** The ID of the pane currently targeted for dismiss/drag-out, or null. */
-    dismissIntentId: string | null;
-    /** Ref setter to measure and track the dashboard root container element. */
-    setContainerRef: (element: HTMLElement | null) => void;
-    /** The ID of the pane currently zoomed to fullscreen, or null. */
-    fullscreenPaneId: string | null;
-    /** Normalized or overridden CSS classes for custom layout styling. */
-    classNames: ZeugmaClassNames;
-    /** Callback triggered when a pane is closed/removed from the dashboard. */
-    onRemove?: (paneId: string) => void;
-    /** Callback triggered to toggle fullscreen status for a pane. */
-    onFullscreenChange?: (paneId: string | null) => void;
-    /** Threshold in pixels to snap layout resizers to adjacent edges. */
-    snapThreshold?: number;
-    /** Callback triggered when a split pane starts being resized. */
-    onResizeStart?: (currentNode: SplitNode) => void;
-    /** Callback triggered continuously during a split pane resize. */
-    onResize?: (currentNode: SplitNode, percentage: number) => void;
-    /** Callback triggered when a split pane resize action is completed. */
-    onResizeEnd?: (currentNode: SplitNode, percentage: number) => void;
-    /** Minimum split percentage allowed when resizing. */
-    minSplitPercentage?: number;
-    /** Maximum split percentage allowed when resizing. */
-    maxSplitPercentage?: number;
-    /** Whether the layout is globally locked. */
-    locked: boolean;
-}
-/**
- * Actions context — holds stable dispatch functions with permanent identity.
- * Consumers of only this context will never re-render from layout/drag state changes.
+ * Shared drag-session lifecycle utility.
+ *
+ * Handles the common boilerplate for pointer-based resize operations:
+ * - Adds `zeugma-resizing` class to `document.body`
+ * - Injects a global `cursor` style so the resize cursor stays active
+ *   even when the pointer leaves the handle element
+ * - Sets `data-resizing` on the resizer element
+ * - Attaches `pointermove` / `pointerup` listeners to `document`
+ * - Cleans everything up on pointer-up
+ *
+ * Consumers provide domain-specific `onMove` and `onEnd` callbacks.
  */
-interface ZeugmaActionsValue {
-    /** Removes the specified pane from the layout tree and collapses its parent split. */
-    removePane: (paneId: string) => void;
-    /** Appends/inserts a pane at the bottom-rightmost leaf of the layout tree. */
-    addPane: (paneId: string) => void;
-    /** Splits a target pane with a new pane in the specified direction and side. */
-    splitPane: (targetId: string, direction: SplitDirection, splitType: 'left' | 'right' | 'top' | 'bottom', paneToAdd: string) => void;
-    /** Updates the split percentage of a specific split branch node. */
-    updateSplitPercentage: (currentNode: SplitNode, percentage: number) => void;
-    /** Stable callback to update metadata for a specific tab. */
-    updateTabMetadata: (tabId: string, updater: (current: Record<string, unknown> | undefined) => Record<string, unknown> | undefined) => void;
-    /** Stable callback to update the locked status of a specific pane in the layout tree. */
-    updatePaneLock: (paneId: string, locked: boolean) => void;
-    /** Stable callback to activate a tab within a pane. */
-    selectTab: (paneId: string, tabId: string) => void;
-    /** Stable callback to merge a dragged tab/pane into another pane's tab list. */
-    mergeTab: (draggedTabId: string, targetPaneId: string) => void;
-    /** Stable callback to move/reorder a tab to another pane next to a target tab. */
-    moveTab: (draggedTabId: string, targetTabId: string, position?: 'before' | 'after') => void;
-    /** Stable callback to remove/close a specific tab from the layout. */
-    removeTab: (tabId: string) => void;
-}
-interface ZeugmaContextValue extends ZeugmaStateValue, ZeugmaActionsValue {
+interface DragSessionConfig {
+    /** CSS cursor to enforce globally during the drag */
+    cursor: 'col-resize' | 'row-resize';
+    /** The resizer DOM element (receives `data-resizing` attribute) */
+    resizerEl: HTMLElement;
+    /** Called on every `pointermove` during the drag */
+    onMove: (e: PointerEvent) => void;
+    /** Called once on `pointerup` — after cleanup has already run */
+    onEnd: () => void;
 }
+declare function createDragSession({ cursor, resizerEl, onMove, onEnd }: DragSessionConfig): void;
+
+declare function safeJsonStringify(val: unknown): string;
+
+declare const ZeugmaStateContext: React.Context<ZeugmaInternalStateValue | undefined>;
+declare const ZeugmaActionsContext: React.Context<ZeugmaActionsValue | undefined>;
+declare const PortalRegistryContext: React.Context<PortalRegistryValue | undefined>;
+declare const useZeugmaState: () => ZeugmaStateValue;
+declare const useZeugmaActions: () => ZeugmaActionsValue;
 
 declare function useZeugma(options: UseZeugmaOptions): ZeugmaController;
 
 declare const useZeugmaContext: () => ZeugmaContextValue;
 
-declare const Zeugma: React.FC<ZeugmaProps>;
+declare const Zeugma: React__default.FC<ZeugmaProps>;
 
 interface UseResizerProps {
-    containerRef: React.RefObject<HTMLDivElement | null>;
+    containerRef: React__default.RefObject<HTMLDivElement | null>;
     isRow: boolean;
     direction: SplitDirection;
     splitPercentage: number;
@@ -227,7 +63,7 @@ interface UseResizerProps {
     parentWidth: number;
     parentHeight: number;
 }
-declare function useResizer({ containerRef, isRow, direction, splitPercentage, resizerSize, snapThreshold, layout, currentNode, onLayoutChange, onResizeStart: localOnResizeStart, onResizeEnd: localOnResizeEnd, parentLeft, parentTop, parentWidth, parentHeight, }: UseResizerProps): (e: React.PointerEvent<HTMLDivElement>) => void;
+declare function useResizer({ containerRef, isRow, direction, splitPercentage, resizerSize, snapThreshold, layout, currentNode, onLayoutChange, onResizeStart: localOnResizeStart, onResizeEnd: localOnResizeEnd, parentLeft, parentTop, parentWidth, parentHeight, }: UseResizerProps): (e: React__default.PointerEvent<HTMLDivElement>) => void;
 
 interface PaneTreeProps {
     /** The layout subtree node to render. If not specified, defaults to the root layout tree from the Zeugma context. */
@@ -237,10 +73,10 @@ interface PaneTreeProps {
     /** Threshold distance in pixels to snap layout resizers to adjacent edges (default 8). */
     snapThreshold?: number;
 }
-declare const PaneTree: React.FC<PaneTreeProps>;
+declare const PaneTree: React__default.FC<PaneTreeProps>;
 
 interface ResizableContainerProps {
-    children: React.ReactNode;
+    children: React__default.ReactNode;
     /** Whether the resizable container is active. When false, acts as a normal 100% height container. */
     active?: boolean;
     /** Current height in pixels (controlled mode) or default/initial height */
@@ -262,7 +98,7 @@ interface ResizableContainerProps {
     /** CSS class applied to the resizer handle */
     resizerClassName?: string;
 }
-declare const ResizableContainer: React.FC<ResizableContainerProps>;
+declare const ResizableContainer: React__default.FC<ResizableContainerProps>;
 
 interface PaneRenderProps {
     /** True if the pane is actively being dragged. */
@@ -299,23 +135,23 @@ interface PaneProps {
     /** The unique ID of the pane, matching a `paneId` in the layout tree schema. */
     id: string;
     /** Render prop function providing pane state (isDragging, isFullscreen, etc.) and handlers. */
-    children: (props: PaneRenderProps) => React.ReactNode;
+    children: (props: PaneRenderProps) => React__default.ReactNode;
     /** Optional inline CSS styles applied to the pane outer container. */
-    style?: React.CSSProperties;
+    style?: React__default.CSSProperties;
     /** Optional override to lock this specific pane. */
     locked?: boolean;
 }
-declare const Pane: React.FC<PaneProps>;
+declare const Pane: React__default.FC<PaneProps>;
 
 interface DragHandleProps {
     /** The children elements that will trigger dragging when held and dragged. */
-    children?: React.ReactNode;
+    children?: React__default.ReactNode;
     /** Custom CSS class applied to the drag handle element. */
     className?: string;
     /** Optional inline CSS styles applied to the drag handle. */
-    style?: React.CSSProperties;
+    style?: React__default.CSSProperties;
 }
-declare const DragHandle: React.FC<DragHandleProps>;
+declare const DragHandle: React__default.FC<DragHandleProps>;
 
 interface TabRenderProps {
     isDragging: boolean;
@@ -327,114 +163,12 @@ interface TabProps {
     /** Whether dragging is locked on this tab. */
     locked?: boolean;
     /** Render prop child function. */
-    children: (props: TabRenderProps) => React.ReactNode;
+    children: (props: TabRenderProps) => React__default.ReactNode;
     /** Custom CSS class applied to the tab wrapper. */
     className?: string;
     /** Custom inline CSS style applied to the tab wrapper. */
-    style?: React.CSSProperties;
+    style?: React__default.CSSProperties;
 }
-declare const Tab: React.FC<TabProps>;
-
-declare const DEFAULT_SNAP_THRESHOLD = 8;
-declare const DEFAULT_DRAG_ACTIVATION_DISTANCE = 8;
-declare const DEFAULT_RESIZER_SIZE = 4;
-
-declare function generateUniqueId(): string;
-/**
- * Tree Helper: Remove a pane container and consolidate the tree structure.
- */
-declare function removePane(tree: TreeNode | null, paneId: string): TreeNode | null;
-/**
- * Tree Helper: Remove a tab from a pane and consolidate the tree structure if no tabs remain.
- */
-declare function removeTab(tree: TreeNode | null, tabId: string): TreeNode | null;
-/**
- * Tree Helper: Insert a pane by splitting an existing target node.
- */
-declare function splitPane(tree: TreeNode | null, targetId: string, direction: SplitDirection, splitType: 'left' | 'right' | 'top' | 'bottom', paneToAdd: string | PaneNode): TreeNode | null;
-/**
- * Tree Helper: Add a pane by recursively splitting the rightmost/bottommost pane in the tree.
- */
-declare function addPane(tree: TreeNode | null, paneToAdd: string): TreeNode;
-/**
- * Tree Helper: Update split percentage recursively.
- */
-declare function updateSplitPercentage(tree: TreeNode | null, target: SplitNode, newPercentage: number): TreeNode | null;
-/**
- * Find a PaneNode by its ID or by any of its tab IDs.
- */
-declare function findPane(tree: TreeNode | null, paneId: string): PaneNode | null;
-/**
- * Update metadata on a specific tab node using an updater function.
- */
-declare function updateTabMetadata(tree: TreeNode | null, tabId: string, updater: (current: Record<string, unknown> | undefined) => Record<string, unknown> | undefined): TreeNode | null;
-/**
- * Update the locked status on a specific pane node in the layout tree.
- */
-declare function updatePaneLock(tree: TreeNode | null, paneId: string, locked: boolean): TreeNode | null;
-/**
- * Tree Helper: Activate a tab within a pane.
- */
-declare function selectTab(tree: TreeNode | null, paneId: string, tabId: string): TreeNode | null;
-/**
- * Tree Helper: Merge a tab into a target pane node.
- */
-declare function mergeTab(tree: TreeNode | null, draggedTabId: string, targetPaneId: string): TreeNode | null;
-/**
- * Tree Helper: Move/reorder a tab inside or to a target pane next to a target tab.
- */
-declare function moveTab(tree: TreeNode | null, draggedTabId: string, targetTabId: string, position?: 'before' | 'after'): TreeNode | null;
-interface ComputedPane {
-    paneId: string;
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-    node: PaneNode;
-}
-interface ComputedSplitter {
-    id: string;
-    currentNode: SplitNode;
-    direction: SplitDirection;
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-    parentLeft: number;
-    parentTop: number;
-    parentWidth: number;
-    parentHeight: number;
-}
-declare function computeLayout(node: TreeNode | null, left?: number, top?: number, width?: number, height?: number, path?: string): {
-    panes: ComputedPane[];
-    splitters: ComputedSplitter[];
-};
-
-/**
- * Shared drag-session lifecycle utility.
- *
- * Handles the common boilerplate for pointer-based resize operations:
- * - Adds `zeugma-resizing` class to `document.body`
- * - Injects a global `cursor` style so the resize cursor stays active
- *   even when the pointer leaves the handle element
- * - Sets `data-resizing` on the resizer element
- * - Attaches `pointermove` / `pointerup` listeners to `document`
- * - Cleans everything up on pointer-up
- *
- * Consumers provide domain-specific `onMove` and `onEnd` callbacks.
- */
-interface DragSessionConfig {
-    /** CSS cursor to enforce globally during the drag */
-    cursor: 'col-resize' | 'row-resize';
-    /** The resizer DOM element (receives `data-resizing` attribute) */
-    resizerEl: HTMLElement;
-    /** Called on every `pointermove` during the drag */
-    onMove: (e: PointerEvent) => void;
-    /** Called once on `pointerup` — after cleanup has already run */
-    onEnd: () => void;
-}
-declare function createDragSession({ cursor, resizerEl, onMove, onEnd }: DragSessionConfig): void;
-
-declare function safeJsonStringify(val: unknown): string;
+declare const Tab: React__default.FC<TabProps>;
 
-export { type ComputedPane, type ComputedSplitter, DEFAULT_DRAG_ACTIVATION_DISTANCE, DEFAULT_RESIZER_SIZE, DEFAULT_SNAP_THRESHOLD, DragHandle, type DragHandleProps, type DragSessionConfig, Pane, type PaneNode, type PaneProps, type PaneRenderProps, PaneTree, ResizableContainer, type ResizableContainerProps, type SplitDirection, type SplitNode, Tab, type TabProps, type TabRenderProps, type TreeNode, type UseZeugmaOptions, Zeugma, type ZeugmaClassNames, type ZeugmaContextValue, type ZeugmaController, type ZeugmaProps, addPane, computeLayout, createDragSession, findPane, generateUniqueId, mergeTab, moveTab, removePane, removeTab, safeJsonStringify, selectTab, splitPane, updatePaneLock, updateSplitPercentage, updateTabMetadata, useResizer, useZeugma, useZeugmaContext };
+export { DEFAULT_DRAG_ACTIVATION_DISTANCE, DEFAULT_RESIZER_SIZE, DEFAULT_SNAP_THRESHOLD, DragHandle, type DragHandleProps, type DragSessionConfig, Pane, type PaneProps, type PaneRenderProps, PaneTree, PortalRegistryContext, PortalRegistryValue, ResizableContainer, type ResizableContainerProps, SplitDirection, SplitNode, Tab, type TabProps, type TabRenderProps, TreeNode, UseZeugmaOptions, Zeugma, ZeugmaActionsContext, ZeugmaActionsValue, ZeugmaContextValue, ZeugmaController, ZeugmaInternalStateValue, ZeugmaProps, ZeugmaStateContext, ZeugmaStateValue, createDragSession, safeJsonStringify, useResizer, useZeugma, useZeugmaActions, useZeugmaContext, useZeugmaState };