@trackunit/react-components 0.0.47 → 0.0.50

package/components/tip/Tip.d.ts

@@ -1,18 +1,23 @@
 import * as React from "react";
 import { CommonProps } from "../../common";
-import { IIconProps } from "../icon/Icon";
+import { IconProps } from "../icon/Icon";
 import { TooltipProps } from "../tooltip";
 export interface TipProps extends CommonProps {
     /**
      * Child nodes to render inside the tip.
      *
-     * @type {React.ReactNode}
      * @memberof TipProps
      */
     children: React.ReactNode;
-    iconProps?: Partial<IIconProps>;
+    iconProps?: Partial<IconProps>;
     tooltipProps?: Partial<TooltipProps>;
 }
+/**
+ * The Tip component is used to show helpful tips for users.
+ *
+ * @param {TipProps} props - The props for the Tip component
+ * @returns {JSX.Element} Tip component
+ */
 export declare const Tip: {
     ({ children, iconProps, tooltipProps, dataTestId, ...rest }: TipProps): JSX.Element;
     displayName: string;

package/components/toggle/Toggle.d.ts

@@ -4,64 +4,38 @@ export declare type ToggleSize = "small" | "default";
 export interface ToggleProps extends CommonProps {
     /**
      * ID of the toggle.
-     *
-     * @type string
-     * @memberof ToggleProps
      */
     id: string;
     /**
      * Whether the toggle is toggled(active) or not.
-     *
-     * @type boolean
-     * @memberof ToggleProps
      */
     toggled: boolean;
     /**
      * onChange event handler.
-     *
-     * @memberof ToggleProps
      */
     onChange: (toggled: boolean, event?: React.ChangeEvent<HTMLInputElement>) => void;
     /**
      * Whether the toggle is disabled or not.
-     *
-     * @type boolean
-     * @memberof ToggleProps
      */
     disabled?: boolean;
     /**
      * Size of the toggle.
-     *
-     * @type "small" | "default"
-     * @memberof ToggleProps
      */
     size?: ToggleSize;
     /**
      * Tab index specifies the keyboard tab order of the toggle relative to the other controls on the page.
-     *
-     * @type number
-     * @memberof ToggleProps
      */
     tabIndex?: number;
     /**
      * Whether the toggle is required or not.
-     *
-     * @type boolean
-     * @memberof ToggleProps
      */
     required?: boolean;
     /**
      * Name of the toggle.
-     *
-     * @type string
-     * @memberof ToggleProps
      */
     name?: string;
     /**
      * onBlur event handler.
-     *
-     * @type {React.FocusEventHandler<HTMLInputElement>}
-     * @memberof ToggleProps
      */
     onBlur?: React.FocusEventHandler<HTMLInputElement>;
 }

package/components/tooltip/Tooltip.d.ts

@@ -5,65 +5,62 @@ export interface TooltipProps {
     /**
      * The text to be displayed in the tooltip.
      *
-     * @type {(string | React.ReactNode)}
      * @memberof TooltipProps
      */
     label: string | React.ReactNode;
     /**
      * Where the tooltip should be placed.
      *
-     * @type {PopoverPlacement}
      * @memberof TooltipProps
      */
     placement?: PopoverPlacement;
     /**
      * Child nodes
      *
-     * @type React.ReactNode
      * @memberof TooltipProps
      */
     children?: React.ReactNode;
     /**
      * Id of test component.
      *
-     * @type string
      * @memberof TooltipProps
      */
     dataTestId?: string;
     /**
      * Whether the tooltip is disabled or not.
      *
-     * @type boolean
      * @memberof TooltipProps
      */
     disabled?: boolean;
     /**
      *  To select either "light" or "dark" mode.
      *
-     * @type "light" | "dark"
      * @memberof TooltipProps
      */
     mode?: "light" | "dark";
     /**
      * Offset value of the tooltip.
      *
-     * @type [number, number]
      * @memberof TooltipProps
      */
     offset?: [number, number];
     /**
      * Additional classes to the component.
      *
-     * @type string
      * @memberof TooltipProps
      */
     className?: string;
     /**
      * Type of content.
      *
-     * @type "p" | "span" | "div"
      * @memberof TooltipProps
      */
     contentTextType?: TextType;
 }
+/**
+ * The Tooltip component.
+ *
+ * @param {TooltipProps} props - The props for the Tooltip component
+ * @returns {JSX.Element} Tooltip component
+ */
 export declare const Tooltip: ({ label, placement, children, dataTestId, disabled, mode, offset, className, contentTextType, }: TooltipProps) => JSX.Element;

package/hooks/useDebounce.d.ts

@@ -1 +1,8 @@
+/**
+ * The useDebounce hook works like useState, but adds a delay where previous values will be ignored.
+ *
+ * @param {any} value The value to set
+ * @param {number} delay The debounce time
+ * @returns {any} value The latest values received
+ */
 export declare const useDebounce: <T>(value: T, delay?: number) => T;

package/hooks/useLocalStorage.d.ts

@@ -1,2 +1,9 @@
 import { Dispatch, SetStateAction } from "react";
+/**
+ * The useLocalStorage hook works like useState, but saves to localstorage.
+ *
+ * @param {string} key - The key the values is saved under.
+ * @param {string | null | undefined} initialValue - The initial value for the state/local storage item
+ * @returns {string | null | undefined} value
+ */
 export declare const useLocalStorage: <TValue = string | null | undefined>(key: string, initialValue?: TValue | undefined) => [TValue | null, Dispatch<SetStateAction<TValue | null>>, () => void];

package/hooks/useTimeout.d.ts

@@ -2,6 +2,12 @@ interface UseTimeoutProps {
     onTimeout: () => void;
     duration: number;
 }
+/**
+ * The useTimeout hook.
+ *
+ * @param {UseTimeoutProps} props The props
+ * @returns {{ startTimeout: () => void; stopTimeout: () => void; }} return
+ */
 export declare const useTimeout: ({ onTimeout, duration }: UseTimeoutProps) => {
     startTimeout: () => void;
     stopTimeout: () => void;