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

package/dist/types/typography/Kbd.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ */
+/**
+ * Renders a styled keyboard shortcut label from a key combination string.
+ *
+ * Parses the `keyCombo` string (e.g., `"Ctrl+S"`) and renders the modifier keys
+ * and main key as uppercase text inside a `<kbd>` element. Arrow keys are rendered
+ * as directional labels (LEFT, RIGHT, UP, DOWN).
+ *
+ * @example
+ * ```tsx
+ * <HotKeyLabel keys={['Ctrl', 'S']} />
+ * // Renders: CTRL S
+ * ```
+ */
+export declare function Kbd({ keys }: {
+    keys: string | string[];
+}): import("react").JSX.Element[];

package/dist/types/typography/Mark.d.ts

@@ -1,18 +1,55 @@
-/// <reference types="react" />
-import { type ChildProp, type ColorType } 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 { ChildProp, CustomColors } from "../types";
 export interface MarkProps extends ChildProp<string> {
     /**
-     * texts to match and abbreviate within
+     * texts to match and highlight within
      *
      * [textPart, color (class name or color string)]
      */
-    mark: Array<[textPart: string, color?: ColorType | string]>;
+    mark: Array<[textPart: string, color?: CustomColors]>;
     /**
      * renderer callback
      */
-    renderer?: (part: string[]) => JSX.Element;
+    renderer?: (part: string[]) => React.ReactElement;
 }
 /**
- * Typography mark component to wrap text parts in `mark`
+ * A component that highlights specific text parts with a mark element, allowing for custom rendering and color.
+ * It tokenizes the children string based on the provided `mark` array,
+ * which contains pairs of text parts and their corresponding colors.
+ * The component can use a custom renderer to display the marked text,
+ * allowing for greater flexibility in how the text is presented.
+ *
+ * @example
+ * <Mark
+ *   mark={[
+ *     ["important", "red"],
+ *     ["note", "blue"],
+ *   ]}
+ * >
+ *   This is an important note that should be highlighted.
+ * </Mark>
  */
-export declare const Mark: ({ children, mark, renderer }: MarkProps) => import("react/jsx-runtime").JSX.Element;
+export declare function Mark({ children, mark, renderer }: MarkProps): import("react").JSX.Element;

package/dist/types/typography/Text.d.ts

@@ -1,35 +1,51 @@
-import { type AriaProps, type ChildrenProp, type ColorWithGrays, type CssProp, type SizeType, type TestProps } from "../types";
-export interface TextProps extends ChildrenProp, CssProp, AriaProps, 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 TextProps extends ChildrenProp, CssProp, TestProps {
     /**
      * render text as inline span
      */
     inline?: boolean;
-    /**
-     * text background (CSS color / tailwind color)
-     */
-    bg?: ColorWithGrays | string;
-    /**
-     * text color (CSS color / tailwind color)
-     */
-    color?: ColorWithGrays | string;
-    /**
-     * text size
-     */
-    size?: SizeType | number | string;
-    /**
-     * font family
-     */
-    family?: "sans" | "serif" | "mono";
-    /**
-     * text align
-     */
-    align?: "start" | "end" | "center" | "justify";
     /**
      * text line clamp
      */
     clamp?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
 }
 /**
- * Typography text component
+ * A component that renders text with various styles, supports line clamping, and provides a "show more" link if the text is clipped.
+ * The component uses a combination of CSS and JavaScript to achieve the desired effects, ensuring a smooth user experience.
+ * It leverages the ResizeObserver API to detect changes in the text container's size and adjust the line clamping accordingly.
+ *
+ * @example
+ * ```jsx
+ * <Text
+ *   inline={false}
+ *   clamp={2}
+ * >
+ *   This is a sample text that demonstrates the Text component with various styles applied.
+ * </Text>
+ * ```
  */
-export declare const Text: ({ children, className, inline, bg, color, family, size, clamp, align, ...aria }: TextProps) => import("react/jsx-runtime").JSX.Element;
+export declare function Text({ children, className, inline, clamp, ...props }: TextProps): import("react").JSX.Element;

package/dist/types/typography/Title.d.ts

@@ -1,29 +1,40 @@
-import { type DetailedHTMLProps, type ElementType, type HTMLAttributes } from "react";
-import { type AriaProps, type ChildrenProp, type ColorWithGrays, type CssProp, type SizeType } from "../types";
-export interface TitleProps extends ChildrenProp, CssProp, AriaProps {
-    as?: ElementType<DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "h1" | "h2" | "h3" | "h4" | "h5" | "h6">;
-    /**
-     * title background
-     */
-    bg?: ColorWithGrays | string;
-    /**
-     * title color (CSS color / tailwind color)
-     */
-    color?: ColorWithGrays | string;
-    /**
-     * title size (CSS color / tailwind color)
-     */
-    size?: SizeType | number | string;
-    /**
-     * font family
-     */
-    family?: "sans" | "serif" | "mono";
-    /**
-     * text align
-     */
-    align?: "start" | "end" | "center" | "justify";
+/**
+ * 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 } from "../types";
+export interface TitleProps extends ChildrenProp, CssProp {
+    as?: React.ElementType<React.DetailedHTMLProps<React.HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "h1" | "h2" | "h3" | "h4" | "h5" | "h6">;
 }
 /**
- * Typography title component
+ * A component that renders a title as different HTML elements based on the `as` prop.
+ * This component is useful for creating headings or titles in a consistent style across an application.
+ *
+ * @example
+ * ```jsx
+ * <Title as="h1">
+ *   This is a Title
+ * </Title>
+ * ```
  */
-export declare const Title: ({ children, className, as, bg, color, size, align, family, ...aria }: TitleProps) => import("react/jsx-runtime").JSX.Element;
+export declare function Title({ children, className, as, ...props }: TitleProps): import("react").JSX.Element;

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

@@ -1,2 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ * Size-to-font-size mapping for the `Title` component.
+ * Maps size tokens (`xs`–`xl`) to rem-based font sizes.
+ */
 export declare const TitleSizeMap: KeyValue<string>;
+/**
+ * Size-to-font-size mapping for the `Text` component.
+ * Maps size tokens (`xs`–`xl`) to rem-based font sizes.
+ */
 export declare const TextSizeMap: KeyValue<string>;

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

@@ -1,6 +1,50 @@
-/** ***************** get css style property value *******************/
-export declare const getCssStyle: (element: HTMLElement, property: string) => string;
-/** ***************** calculate full width for given element *******************/
-export declare const calculateTextWidth: (element: HTMLElement, styleRoot?: HTMLElement) => number;
-/** ***************** calculate full height for given element *******************/
-export declare const calculateTextHeight: (element: HTMLElement, styleRoot?: HTMLElement) => number;
+/**
+ * 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.
+ */
+/**
+ * Retrieves a computed CSS property value from an element.
+ *
+ * @param {HTMLElement} element - The DOM element to read from.
+ * @param {string} property - The CSS property name to retrieve.
+ * @returns The computed value of the property.
+ */
+export declare function getCssStyle(element: HTMLElement, property: string): string;
+/**
+ * Calculates the full rendered width of an element by cloning it with matching styles
+ * and measuring its offsetWidth in an off-screen position.
+ *
+ * @param {HTMLElement} element - The element to measure.
+ * @param {HTMLElement} styleRoot - Optional element whose computed styles to copy; falls back to element itself.
+ * @returns The element's full width in pixels.
+ */
+export declare function calculateTextWidth(element: HTMLElement, styleRoot?: HTMLElement): number;
+/**
+ * Calculates the full rendered height of an element by cloning it with matching styles
+ * and measuring its offsetHeight in an off-screen position.
+ *
+ * @param {HTMLElement} element - The element to measure.
+ * @param {HTMLElement} styleRoot - Optional element whose computed styles to copy; falls back to element itself.
+ * @returns The element's full height in pixels.
+ */
+export declare function calculateTextHeight(element: HTMLElement, styleRoot?: HTMLElement): number;

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

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+/**
+ * Flattens and clones React children, unwrapping `Fragment` wrappers.
+ *
+ * Recursively processes children to flatten nested `Fragment` elements,
+ * returning a plain array of cloned React nodes. Useful when you need
+ * to iterate over children without Fragment wrappers interfering.
+ *
+ * @param {React.ReactNode} children - The React children to flatten and clone.
+ * @returns An array of cloned React nodes, or `undefined` if children is falsy.
+ *
+ * @example
+ * ```tsx
+ * const children = cloneChildren(<><div>A</div><Fragment><div>B</div></Fragment></>);
+ * // Returns: [<div>A</div>, <div>B</div>]
+ * ```
+ */
+export declare function cloneChildren(children: React.ReactNode): React.ReactNode[] | undefined;

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

@@ -0,0 +1,16 @@
+import type { BadgeType } from "../components/badge/Badge";
+/**
+ * Utility function to get badge properties from a badge value or object.
+ * It checks if the badge is an object and returns its properties,
+ *
+ * @param {string | number | BadgeType} badge - The badge value or object.
+ * @returns {BadgeType} An object containing badge properties.
+ */
+export declare function getBadgeProps(badge?: string | number | BadgeType): ({
+    forButton: boolean;
+    placement: string;
+} & BadgeType) | {
+    value: string | number | (BadgeType & import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>) | undefined;
+    forButton: boolean;
+    placement: string;
+};

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

@@ -1,4 +1,43 @@
-export declare const getColor: (color: string) => string | undefined;
-export declare const getBgClass: (bg: string) => string | undefined;
-export declare const getColorClass: (color: string) => string | undefined;
-export declare const getBorderClass: (color: string) => string | undefined;
+/**
+ * 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.
+ */
+/**
+ * Resolves a color value to a CSS color string.
+ *
+ * If the input is a valid CSS color (e.g., `"#ff0000"`, `"rgb(255,0,0)"`), it is returned as-is.
+ * Otherwise, it is treated as a design token name and resolved to a CSS custom property
+ * (e.g., `"primary-500"` → `"var(--color-primary-500)"`).
+ *
+ * @param {ColorUnion} color - The color value to resolve. Accepts CSS color strings or design token names.
+ * @returns The resolved CSS color string, or `undefined` if color is falsy.
+ *
+ * @example
+ * ```ts
+ * getColor("primary-500");    // "var(--color-primary-500)"
+ * getColor("#ff0000");       // "#ff0000"
+ * getColor("red");           // "var(--color-red)"
+ * getColor(undefined);       // undefined
+ * ```
+ */
+export declare function getColor(color?: string): string | undefined;

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

@@ -0,0 +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 type { BaseIconProps, IconProps } from "../components/icon/Icon";
+/**
+ * Normalizes an `IconProps` value into a `BaseIconProps` object.
+ *
+ * If the input is a string or a React element, wraps it in an `{ icon }` object.
+ * If it's already a `BaseIconProps` object, returns it as-is.
+ *
+ * @param {IconProps} props - An icon specification: a string (CSS class or SVG path), a React element, or a `BaseIconProps` object.
+ * @returns A `BaseIconProps` object suitable for spreading onto the `Icon` component.
+ *
+ * @example
+ * ```tsx
+ * getIconProps("icon-[mdi--home]");
+ * // { icon: "icon-[mdi--home]" }
+ * getIconProps(<MyIcon />);
+ * // { icon: <MyIcon /> }
+ * getIconProps({ icon: "M10 20v-6h4v6" });
+ * // { icon: "M10 20v-6h4v6" }
+ * ```
+ */
+export declare function getIconProps(props: IconProps): BaseIconProps;

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

@@ -0,0 +1,47 @@
+/**
+ * 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 { TooltipType } from "../components/tooltip/Tooltip";
+/**
+ * Normalizes a tooltip specification into `TooltipType` props.
+ *
+ * If the input is a string or React element, returns a basic tooltip config
+ * with `placement: "top"` and the content set. If it's an object, merges
+ * it with the base config (adding `ref` and `placement`).
+ *
+ * @param {TooltipType} tooltip - A tooltip string, React element, or full `TooltipType` config.
+ * @param {RefObject<HTMLElement>} innerRef - Optional ref to attach to the tooltip's trigger element.
+ * @returns A `TooltipType` config with `ref` and `placement` set, or `undefined` if tooltip is falsy.
+ *
+ * @example
+ * ```tsx
+ * getTooltipProps("Hello world");
+ * // { ref, placement: "top", content: "Hello world" }
+ * getTooltipProps({ content: "Tip", placement: "bottom" });
+ * // { ref, placement: "bottom", content: "Tip" }
+ * ```
+ */
+export declare function getTooltipProps(tooltip?: string | TooltipType, innerRef?: React.RefObject<HTMLElement>): (TooltipType & {
+    ref: AnyObject;
+}) | undefined;

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

@@ -1,3 +1,31 @@
+/**
+ * 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 * from "./calculateDimensions";
+export * from "./cloneElement";
+export * from "./getBadgeProps";
 export * from "./getColor";
+export * from "./getIconProps";
+export * from "./getTooltipProps";
 export * from "./nodeCheck";

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

@@ -1,2 +1 @@
-import { type ComponentType } from "react";
-export declare const nodeCheck: (node: AnyObject, ...types: Array<ComponentType<AnyObject>>) => boolean;
+export declare function nodeCheck(node: React.ReactNode, ...types: Array<React.ComponentType<AnyObject>>): node is React.ReactElement;