@astryxdesign/core 0.5.2-canary.2da7a39 → 0.5.2-canary.2e51213

package/dist/Resizable/useResizable.d.ts

@@ -1,10 +1,49 @@
-export interface ResizableRegionConfig {
-    /** Default size in pixels, or percentage string (e.g. '20%'). */
-    defaultSize?: number | string;
-    /** Minimum size in pixels. @default 50 */
+/**
+ * @file useResizable.ts
+ * @input Resize configuration (defaultSize, minSize, maxSize, legacy pixel
+ *   aliases, snaps) and collapse configuration (collapsible,
+ *   defaultIsCollapsed, isCollapsed)
+ * @output Hook return: size, isCollapsed, collapse/expand/resize methods, props for handle
+ * @position Public hook; consumed by layout components via `resizable` prop
+ */
+import { type RefObject } from 'react';
+import type { SizeValue } from '../utils/types';
+import type { ResizableSize } from './utils';
+/**
+ * The minimum, in one of two spellings. Exactly one may be supplied: the union
+ * makes passing both a type error, so a migration cannot leave a stale
+ * deprecated value shadowing the new one (AST-010 API4).
+ */
+export type ResizableMinConfig = {
+    minSize?: ResizableSize;
+    minSizePx?: never;
+} | {
+    minSize?: never;
     minSizePx?: number;
-    /** Maximum size in pixels. @default Infinity */
+};
+/** The maximum, in one of two spellings. See {@link ResizableMinConfig}. */
+export type ResizableMaxConfig = {
+    maxSize?: ResizableSize;
+    maxSizePx?: never;
+} | {
+    maxSize?: never;
     maxSizePx?: number;
+};
+export type ResizableDirection = 'horizontal' | 'vertical';
+export interface ResizableRegionSizing {
+    /**
+     * Initial size. A number is pixels, exact `Npx` is pixels, exact `N%` is a
+     * share of the basis, and the structured percent form in
+     * {@link ResizableSize} adds exactly one pixel floor or ceiling to that percentage. The public type retains the released
+     * {@link SizeValue} (`number | string`) for compatibility, so runtime
+     * validation remains authoritative for strings.
+     *
+     * A basis-dependent value resolves ONCE into a pixel size — against the
+     * container when `containerRef` is supplied, against the viewport otherwise.
+     * It configures the initial selection; it does not make the region track its
+     * basis afterwards.
+     */
+    defaultSize?: ResizableSize | SizeValue;
     /** Whether this region can collapse to 0. @default false */
     collapsible?: boolean;
     /** Size in px at which dragging triggers collapse. @default 40 */
@@ -14,6 +53,7 @@ export interface ResizableRegionConfig {
     /** Cascade priority — lower number shrinks first. */
     shrinkOrder?: number;
 }
+export type ResizableRegionConfig = ResizableRegionSizing & ResizableMinConfig & ResizableMaxConfig;
 /**
  * Shared config shape for any component that integrates built-in resize
  * (e.g. SideNav `resizable` prop). Provides a simplified API surface
@@ -37,7 +77,23 @@ export interface ResizableConfig {
     /** Called when collapse state changes (via drag or programmatic). */
     onCollapseChange?: (isCollapsed: boolean) => void;
 }
-export interface UseResizableSingleConfig extends ResizableRegionConfig {
+export interface UseResizableSingleOptions {
+    /**
+     * The element a percentage is a share of. Caller-owned: only the caller
+     * knows which element is the intended layout container, so the hook never
+     * infers one from the panel or the handle.
+     *
+     * Omitted, percentages keep the released viewport basis. Supplied, they use
+     * this element's content-box size on the active axis. It changes the basis
+     * only — it does not make a selected size responsive.
+     */
+    containerRef?: RefObject<HTMLElement | null>;
+    /**
+     * Which axis this region resizes along. Selects the container's inline or
+     * block content-box size as the percentage basis, and must match the
+     * `direction` given to `ResizeHandle`. @default 'horizontal'
+     */
+    direction?: ResizableDirection;
     /** Unique key for localStorage persistence. */
     autoSaveId?: string;
     /**
@@ -57,9 +113,16 @@ export interface UseResizableSingleConfig extends ResizableRegionConfig {
     /** Called when collapse state changes (via drag or programmatic). */
     onCollapseChange?: (isCollapsed: boolean) => void;
 }
+export type UseResizableSingleConfig = ResizableRegionConfig & UseResizableSingleOptions;
 export interface UseResizableMultiConfig {
-    /** Layout direction. @default 'horizontal' */
-    direction?: 'horizontal' | 'vertical';
+    /** Layout direction, shared by every region. @default 'horizontal' */
+    direction?: ResizableDirection;
+    /**
+     * One container for every region's percentage basis. Regions stay
+     * independently pixel-selected; sharing a basis adds no ratio or
+     * total-100% invariant between them.
+     */
+    containerRef?: RefObject<HTMLElement | null>;
     /** Named region configurations. */
     regions: Record<string, ResizableRegionConfig>;
     /** Unique key for localStorage persistence. */
@@ -85,12 +148,30 @@ export interface ResizableProps {
     _onResizeStart: () => void;
     _onResizeMove: (delta: number) => void;
     _onResizeEnd: () => void;
+    /**
+     * The gesture ended without completing — pointercancel, a lost pointer
+     * capture, or a handle unmounted mid-drag. Separate from `_onResizeEnd`
+     * because a cancelled drag deliberately does not signal a resize end (#5297),
+     * but it must still release everything the gesture was holding.
+     *
+     * Optional: `ResizableProps` is exported, so a hand-built object from before
+     * this existed has to keep compiling.
+     */
+    _onResizeCancel?: () => void;
     _minSizePx: number;
     _maxSizePx: number;
     _snaps: number[];
     _collapsedSize: number;
     /** Whether the region supports collapsing. */
     _collapsible: boolean;
+    /**
+     * The hook's axis, so a handle can flag a direction mismatch.
+     *
+     * Optional for the same reason as `_onResizeCancel`: this type is exported,
+     * and requiring a new field would break every object literal that already
+     * satisfies it. Absent means "no axis to check", not "horizontal".
+     */
+    _direction?: ResizableDirection;
     _isResizableProps: true;
 }
 export declare function useResizable(config: UseResizableSingleConfig): ResizableRegion;

package/dist/Resizable/useResizable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useResizable.d.ts","sourceRoot":"","sources":["../../src/Resizable/useResizable.ts"],"names":[],"mappings":"AAkBA,MAAM,WAAW,qBAAqB;IACpC,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,uBAAuB;IACtC,8CAA8C;IAC9C,SAAS,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IACtC,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC/C,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,WAAW,EAAE,OAAO,CAAC;IACrB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,wCAAwC;IACxC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,uEAAuE;IACvE,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IAEd,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAE9C,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,IAAI,CAAC;CACzB;AA2UD,wBAAgB,YAAY,CAAC,MAAM,EAAE,wBAAwB,GAAG,eAAe,CAAC;AAChF,wBAAgB,YAAY,CAC1B,MAAM,EAAE,uBAAuB,GAC9B,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC"}
+{"version":3,"file":"useResizable.d.ts","sourceRoot":"","sources":["../../src/Resizable/useResizable.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AAEH,OAAO,EAML,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAIf,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAM3C;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAC,GAC5C;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE1C,4EAA4E;AAC5E,MAAM,MAAM,kBAAkB,GAC1B;IAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAC,GAC5C;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE1C,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE3D,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACxC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GACvD,kBAAkB,GAClB,kBAAkB,CAAC;AAErB;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAC7C;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,GAC1D,yBAAyB,CAAC;AAE5B,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAC7C,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC/C,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,WAAW,EAAE,OAAO,CAAC;IACrB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,wCAAwC;IACxC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,uEAAuE;IACvE,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IAEd,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAE9C,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,iBAAiB,EAAE,IAAI,CAAC;CACzB;AAg8BD,wBAAgB,YAAY,CAAC,MAAM,EAAE,wBAAwB,GAAG,eAAe,CAAC;AAChF,wBAAgB,YAAY,CAC1B,MAAM,EAAE,uBAAuB,GAC9B,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC"}