@react-fabric/core 1.0.0-beta.8 → 1.0.1

package/dist/types/core/boundary/ErrorBoundary.d.ts

@@ -1,7 +1,45 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 import { Component } from "react";
-import { type ChildrenProp } from "../../types";
+import type { ChildrenProp } from "../../types";
+interface ErrorComponentProps {
+    error?: string;
+    errorElement?: React.ComponentType<{
+        error?: string;
+    }>;
+}
 /**
- * An error boundary wrapper higher-order component designed to provide consistent error display across the application will trap runtime errors
+ * Catches JavaScript errors in the child tree, logs them, and displays a fallback UI.
+ * It can be used to wrap any component tree to prevent the entire application from crashing due to errors in a specific part of the UI.
+ *
+ * @example
+ * ```tsx
+ * <ErrorBoundary errorElement={CustomErrorComponent}>
+ *   <MyComponent />
+ * </ErrorBoundary>
+ * ```
  */
 export declare class ErrorBoundary extends Component<{
     /**
@@ -20,7 +58,8 @@ export declare class ErrorBoundary extends Component<{
         error: string;
         stack: string | undefined;
     };
-    constructor(props: AnyObject);
+    constructor(props: ErrorComponentProps & ChildrenProp);
     componentDidCatch(error: Error): void;
-    render(): string | number | boolean | Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
+    render(): string | number | bigint | boolean | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined> | import("react").JSX.Element | null | undefined;
 }
+export {};

package/dist/types/core/boundary/ErrorIcon.d.ts

@@ -1 +1,38 @@
-export declare const ErrorIcon: () => import("react/jsx-runtime").JSX.Element;
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Error icon displayed within the ErrorBoundary fallback UI.
+ *
+ * Renders a circular icon with a red background and a white information
+ * symbol (an "i" inside a rectangle), used to visually indicate an error state.
+ *
+ * @example
+ * ```tsx
+ * import { ErrorIcon } from "@react-fabric/core";
+ *
+ * <ErrorIcon />
+ * ```
+ */
+export declare const ErrorIcon: () => import("react").JSX.Element;

package/dist/types/core/content/Content.d.ts

@@ -1,16 +1,48 @@
-import { type MouseEvent } from "react";
-import { type ChildrenProp, type CssProp, type RefProp, type ScrollObject, type SizeObject, type TestProps } from "../../types";
-export interface ContentProps extends ChildrenProp, CssProp, RefProp, TestProps {
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import type { ChildrenProp, CssProp, RefProp, ScrollObject, SizeObject, TestProps } from "../../types";
+export interface ContentProps extends ChildrenProp, CssProp, RefProp<HTMLDivElement>, TestProps {
     /**
      * scroll vevent handler
      */
-    onScroll?: (scroll: ScrollObject, event: MouseEvent<HTMLDivElement>) => void;
+    onScroll?: (scroll: ScrollObject, event: React.MouseEvent<HTMLDivElement>) => void;
     /**
      * scroll vevent handler
      */
     onResize?: (event: SizeObject) => void;
 }
 /**
- * Scrollable content element
+ * Content component that wraps children in a section element.
+ * It uses a resize observer to handle resizing and a debounced scroll handler.
+ * It also includes an error boundary to catch any errors in the children.
+ *
+ * @example
+ * ```tsx
+ * <Content onScroll={handleScroll} onResize={handleResize}>
+ *   <div>Child content</div>
+ * </Content>
+ * ```
  */
-export declare const Content: ({ ref, children, className, onScroll, onResize, "data-testid": testId, "data-test-value": testValue, }: ContentProps) => import("react/jsx-runtime").JSX.Element;
+export declare function Content({ ref, children, className, onScroll, onResize, ...props }: ContentProps): import("react").JSX.Element;

package/dist/types/core/headfoot/HeadFoot.d.ts

@@ -1,24 +1,58 @@
-import { type AriaProps, type ChildrenProp, type ColorWithGrays, type CssProp, type TestProps } from "../../types";
-interface BaseProps extends CssProp, AriaProps, ChildrenProp, TestProps {
-    dir?: "ltr" | "rtl";
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import type { ChildrenProp, CollapseProps, CssProp, HeightProps, TestProps } from "../../types";
+interface BaseProps extends CssProp, ChildrenProp, TestProps, CollapseProps, HeightProps {
+    flex?: boolean;
+    align?: "start" | "end" | "center" | "stretch";
+    justify?: "start" | "end" | "center" | "between";
+    id?: string;
+    hideCollapseHandle?: boolean;
     /**
-     * background color
+     * resizable header/footer
      */
-    bg?: ColorWithGrays | string;
+    resizeable?: boolean;
     /**
-     * background color
+     * Resize event
      */
-    color?: ColorWithGrays | string;
+    onResize?: (height: number) => void;
 }
-type DefaultProps = BaseProps & {
+type DefaultProps = {
     flex?: false;
+    align?: never;
+    justify?: never;
 };
-type FlexProps = BaseProps & {
+type FlexProps = {
     flex: true;
-    align?: "start" | "end" | "center" | "stretch";
-    justify?: "start" | "end" | "center" | "between";
 };
-export type HeadFootProps = DefaultProps | FlexProps;
-export declare const Header: (props: HeadFootProps) => import("react/jsx-runtime").JSX.Element;
-export declare const Footer: (props: HeadFootProps) => import("react/jsx-runtime").JSX.Element;
+export type HeadFootProps = BaseProps & (DefaultProps | FlexProps);
+/**
+ * Header component wrapping children in a header element. Delegates to HeadFoot with `as="header"`.
+ */
+export declare function Header(props: HeadFootProps): import("react").JSX.Element;
+/**
+ * Footer component wrapping children in a footer element. Delegates to HeadFoot with `as="footer"`.
+ */
+export declare function Footer(props: HeadFootProps): import("react").JSX.Element;
 export {};

package/dist/types/core/layout/Layout.d.ts

@@ -0,0 +1,38 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import type { ChildrenProp, CssProp, RefProp } from "../../types";
+/**
+ * A component that represents a layout section of content within a page, with templated grid layout.
+ * It can be used to group related content together and can be styled with additional CSS classes.
+ * It supports RTL (right-to-left) text direction.
+ *
+ * @example
+ * ```jsx
+ * <Layout className="my-layout" ref={layoutRef}>
+ *   <p>This is a layout.</p>
+ * </Layout>
+ * ```
+ */
+export declare function Layout({ children, className, ref, ...rest }: CssProp & ChildrenProp & RefProp<HTMLDivElement>): import("react").JSX.Element;

package/dist/types/core/responsive/Responsive.d.ts

@@ -1,23 +1,43 @@
-import { type AriaProps, type ChildrenProp, type CssProp, type SizeTypeWithZero, type TestProps } from "../../types";
-export interface ContainerProps extends AriaProps, CssProp, ChildrenProp, TestProps {
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import type { ChildrenProp, CssProp, TestProps } from "../../types";
+export interface ContainerProps extends CssProp, ChildrenProp, TestProps {
     /**
      * use full width
      */
     fullWidth?: boolean;
     /**
-     * gutter size
+     * use @container size queries for max-width
      */
-    gutter?: SizeTypeWithZero;
+    useContainer?: boolean;
 }
-export interface RowProps extends AriaProps, CssProp, ChildrenProp, TestProps {
+export interface RowProps extends CssProp, ChildrenProp, TestProps {
     /**
      * no wrapping
      */
     noWrap?: boolean;
-    /**
-     * gutter size
-     */
-    gutter?: SizeTypeWithZero;
     /**
      * flex orientation
      */
@@ -31,7 +51,7 @@ export interface RowProps extends AriaProps, CssProp, ChildrenProp, TestProps {
      */
     justify?: "start" | "end" | "center" | "between";
 }
-export interface ColProps extends AriaProps, CssProp, TestProps, Partial<ChildrenProp> {
+export interface ColProps extends CssProp, TestProps, Partial<ChildrenProp> {
     /**
      * align items
      */
@@ -39,15 +59,25 @@ export interface ColProps extends AriaProps, CssProp, TestProps, Partial<Childre
     /**
      * column flex
      */
-    flex?: "auto" | "fill" | "full";
+    flex?: "fill" | "full" | "initial" | "content";
     /**
      * stretch inner content
      */
     stretchContent?: boolean;
+    /**
+     * truncate text
+     */
+    truncate?: boolean;
 }
 /**
- * Responsive layout container
+ * Container that wraps children in a div with optional full-width and container-size queries.
+ */
+export declare function Container({ children, fullWidth, className, useContainer, ...props }: ContainerProps): import("react").JSX.Element;
+/**
+ * Row component with flex layout, supporting orientation, alignment, and wrapping.
+ */
+export declare function Row({ children, noWrap, orient, align, justify, className, ...props }: RowProps): import("react").JSX.Element;
+/**
+ * Column component within a Row, supporting flex sizing, alignment, and text truncation.
  */
-export declare const Container: ({ children, fullWidth, className, gutter, ...aria }: ContainerProps) => import("react/jsx-runtime").JSX.Element;
-export declare const Row: ({ children, gutter, noWrap, orient, align, justify, className, ...aria }: RowProps) => import("react/jsx-runtime").JSX.Element;
-export declare const Col: ({ children, flex, align, className, stretchContent, ...aria }: ColProps) => import("react/jsx-runtime").JSX.Element;
+export declare function Col({ children, flex, align, truncate, className, stretchContent, ...props }: ColProps): import("react").JSX.Element;

package/dist/types/core/theme/ThemeProvider.d.ts

@@ -1,4 +1,28 @@
-import { type ChildrenProp } from "../../types";
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import type { ChildrenProp, CustomColors } from "../../types";
 export interface ThemeProps {
     /**
      * light/dark color scheme
@@ -8,30 +32,30 @@ export interface ThemeProps {
      * branding css className
      *
      * .branding {
-     *  --primary: #color;
-     *  --accent: #color;
-     *  --tint: #color;
+     *  --color-primary: #color;
+     *  --color-secondary: #color;
+     *  --color-tint: #color;
      * }
      */
     branding?: string;
     /**
      * primary color
      */
-    primaryColor?: string;
+    primaryColor?: CustomColors;
     /**
-     * accent color
+     * secondary color
      */
-    accentColor?: string;
+    secondaryColor?: CustomColors;
     /**
      * tint mix color
      */
-    tintColor?: string;
+    tintColor?: CustomColors;
     /**
      * component rounding
      */
-    rounding?: "minimal" | "normal" | "full";
+    rounding?: "sm" | "md" | "full";
 }
 /**
- * Theme override
+ * Sets CSS custom properties for theme colors (primary, secondary, tint) and applies branding class.
  */
-export declare const ThemeProvider: ({ children, branding, primaryColor, accentColor, tintColor, colorScheme, rounding, }: ThemeProps & ChildrenProp) => import("react/jsx-runtime").JSX.Element;
+export declare function ThemeProvider({ children, branding, primaryColor, secondaryColor, tintColor, colorScheme, rounding, }: ThemeProps & ChildrenProp): import("react").JSX.Element;

package/dist/types/core/viewport/Viewport.d.ts

@@ -1,5 +1,29 @@
-import { type PropsWithChildren } from "react";
 /**
- * The application viewport is the main container that defines the visible area where content is displayed and interacted with.
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
-export declare const Viewport: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element;
+import type { ChildrenProp } from "../../types";
+/**
+ * Full-screen viewport container with grid layout and container queries.
+ */
+export declare function Viewport({ children }: ChildrenProp): import("react").JSX.Element;

package/dist/types/hooks/useClientService.d.ts

@@ -1 +1,43 @@
-export declare const useClientService: (clientApi: AnyObject, serverMock?: AnyObject) => any;
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Custom hook that returns a client-side API on the client and a server-side mock on the server.
+ *
+ * Useful for isomorphic components that need different behavior during SSR vs. CSR,
+ * such as accessing browser APIs or window objects that are unavailable during server rendering.
+ *
+ * @param {any} clientApi - The client-side API object to return when running in the browser.
+ * @param {any} serverMock - The mock API object to return when running on the server.
+ * @returns The client API on the client, the server mock on the server, or `undefined` if neither is provided.
+ *
+ * @example
+ * ```tsx
+ * const clipboard = useClientService(
+ *   { write: (text) => navigator.clipboard.writeText(text) },
+ *   { write: () => Promise.resolve() }
+ * );
+ * ```
+ */
+export declare function useClientService<T extends AnyObject = AnyObject>(clientApi: T, serverMock?: T): T | undefined;

package/dist/types/hooks/useContextMenu.d.ts

@@ -0,0 +1,10 @@
+import { type Menu } from "../components/menu/Menu";
+/**
+ * A hook that provides a context menu that appears on right-click.
+ * It uses the Floating UI library to manage the positioning and interactions of the menu.
+ * This hook is useful for creating custom context menus that can be triggered by right-clicking on elements.
+ *
+ * @param {ContextMenuProps} props - The properties for the ContextMenu hook.
+ * @returns {[React.ReactElement | null, (e: MouseEvent) => void]} An array containing the rendered ContextMenu component (or null if not open) and the function to handle right-click events.
+ */
+export declare function useContextMenu(menu: React.ReactElement<typeof Menu>): [Overlay: React.ReactNode, onContentMenu: (e: React.MouseEvent) => void];

package/dist/types/hooks/useControlledValue.d.ts

@@ -1,5 +1,29 @@
-/// <reference types="react" />
-export declare const useControlledValue: <T extends unknown = string>(value: T, defaultValue: T) => {
-    currentValue: T;
-    updateValue: import("react").Dispatch<import("react").SetStateAction<T>>;
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/** Hook managing a controlled value with a default fallback, using useDeferredValue for smooth updates. Returns [currentValue, updateValue]. */
+export declare function useControlledValue<T extends AnyObject = string>(value: T | undefined, defaultValue: T | undefined): {
+    currentValue: T | undefined;
+    updateValue: import("react").Dispatch<import("react").SetStateAction<T | undefined>>;
 };

package/dist/types/hooks/useDebounce.d.ts

@@ -1,4 +1,40 @@
-export declare const useDebounce: (callback: undefined | ((...rest: AnyObject) => AnyObject), deps: AnyObject[], delay?: number) => {
-    (...args: AnyObject): void;
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Custom hook to debounce a function.
+ * This hook delays the processing of the function until after a specified delay period
+ * has elapsed since the last time the function was invoked. This is useful for optimizing
+ * performance in scenarios where a function may be called frequently, such as during
+ * user input or window resizing events.
+ *
+ * @param {Function} callback - The function to debounce.
+ * @param {DependencyList} deps - The dependency array for the hook.
+ * @param {number} delay - The debounce delay in milliseconds.
+ * @returns A debounced version of the callback function.
+ */
+export declare function useDebounce(callback: undefined | ((...rest: AnyObject) => AnyObject), deps: React.DependencyList, delay?: number): {
+    (...args: unknown[]): void;
     cancel(): void;
 };