@unifiedsoftware/react-ui 1.0.7 → 1.0.8-beta

package/dist/index.d.ts

@@ -1,51 +1,93 @@
 import * as react from 'react';
-import react__default, { ReactNode, FC, Dispatch, SetStateAction } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as styled_components from 'styled-components';
-import * as react_router_dom from 'react-router-dom';
+import react__default, { Dispatch, SetStateAction } from 'react';
 
 type BadgePlacement = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
-interface Props$c {
+interface Props$6 {
+    /**
+     * The placement of the badge relative to its content.
+     */
     placement?: BadgePlacement;
+    /**
+     * The content to display within the badge.
+     */
     content?: React.ReactNode;
 }
-type NativeAttrs$6 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$c>;
-type BadgeProps = Props$c & NativeAttrs$6;
+type NativeAttrs$6 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$6>;
+type BadgeProps = Props$6 & NativeAttrs$6;
 declare const Badge: React.FC<BadgeProps>;
 
 type ButtonVariant = 'filled' | 'outlined' | 'text' | 'plain';
 type ButtonColor = 'primary' | 'secondary' | 'success' | 'info' | 'warning' | 'danger';
 type ButtonSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
 
-interface Props$b {
+interface Props$5 {
+    /**
+     * The HTML element type or React component to render as the button.
+     */
     as?: React.ElementType;
+    /**
+     * The variant style of the button.
+     */
     variant?: ButtonVariant;
+    /**
+     * The color of the button.
+     */
     color?: ButtonColor;
+    /**
+     * The size of the button.
+     */
     size?: ButtonSize;
+    /**
+     * Content to display as an icon within the button. Typically an icon component.
+     */
     iconOnly?: React.ReactNode;
+    /**
+     * Content to display at the start of the button, before the button's text.
+     */
     startContent?: React.ReactNode;
+    /**
+     * Content to display at the end of the button, after the button's text.
+     */
     endContent?: React.ReactNode;
+    /**
+     * Whether the button is in a loading state.
+     */
     loading?: boolean;
+    /**
+     * Whether the button is disabled.
+     */
     disabled?: boolean;
 }
-type NativeAttrs$5 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$b>;
-type ButtonProps = Props$b & NativeAttrs$5;
-declare const Button: react.ForwardRefExoticComponent<Props$b & NativeAttrs$5 & react.RefAttributes<HTMLButtonElement>>;
+type NativeAttrs$5 = Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, keyof Props$5>;
+type ButtonProps = Props$5 & NativeAttrs$5;
+declare const Button: react.ForwardRefExoticComponent<Props$5 & NativeAttrs$5 & react.RefAttributes<HTMLButtonElement>>;
 
 type ChipVariant = 'filled' | 'outlined' | 'text';
 type ChipColor = 'primary' | 'secondary' | 'success' | 'info' | 'warning' | 'danger';
 type ChipSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
 
-interface Props$a {
+interface Props$4 {
+    /**
+     * The HTML element type or React component to render as the chip.
+     */
     as?: React.ElementType;
+    /**
+     * The variant style of the chip.
+     */
     variant?: ChipVariant;
+    /**
+     * The color of the chip.
+     */
     color?: ChipColor;
+    /**
+     * The size of the chip.
+     */
     size?: ChipSize;
 }
-type NativeAttrs$4 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$a>;
-type ChipProps = Props$a & NativeAttrs$4;
-declare const Chip: react.ForwardRefExoticComponent<Props$a & NativeAttrs$4 & react.RefAttributes<HTMLDivElement>>;
+type NativeAttrs$4 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$4>;
+type ChipProps = Props$4 & NativeAttrs$4;
+declare const Chip: react.ForwardRefExoticComponent<Props$4 & NativeAttrs$4 & react.RefAttributes<HTMLDivElement>>;
 
 interface CollapseProps {
     children: React.ReactNode;
@@ -77,31 +119,56 @@ interface CollapseTriggerProps {
 }
 declare const CollapseTrigger: react__default.FC<CollapseTriggerProps>;
 
-interface Props$9 {
+interface IconProps {
+    children: React.ReactNode;
+    color?: 'primary' | 'secondary';
+    size?: 'sm' | 'md' | 'lg';
+}
+declare const Icon: react.ForwardRefExoticComponent<IconProps & react.RefAttributes<unknown>>;
+
+interface Props$3 {
+    /**
+     * The HTML element type or React component to render as the menu item.
+     */
     as?: React.ElementType;
+    /**
+     * The value associated with the menu item.
+     */
     value?: any;
+    /**
+     * The title to display for the menu item.
+     */
     title: string;
+    /**
+     * Optional icon to display with the menu item.
+     */
     icon?: React.ReactNode;
+    /**
+     * The nesting level of the menu item, for hierarchical menus.
+     */
     level?: number;
+    /**
+     * Whether the item is disabled.
+     */
     disabled?: boolean;
 }
-type NativeAttrs$3 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$9 | 'items'>;
-type MenuItemProps$1 = Props$9 & NativeAttrs$3;
-declare const MenuItem$1: react.ForwardRefExoticComponent<Props$9 & NativeAttrs$3 & {
+type NativeAttrs$3 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$3 | 'items'>;
+type MenuItemProps = Props$3 & NativeAttrs$3;
+declare const MenuItem: react.ForwardRefExoticComponent<Props$3 & NativeAttrs$3 & {
     children?: react.ReactNode;
 } & react.RefAttributes<HTMLDivElement>>;
 
-type MenuSubmenuProps = Omit<MenuItemProps$1, 'items'> & {
+type MenuSubmenuProps = Omit<MenuItemProps, 'items'> & {
     items?: MenuItemType[];
 };
 declare const MenuSubmenu: React.FC<MenuSubmenuProps>;
 
-type MenuGroupItemType = (MenuItemProps$1 & {
+type MenuGroupItemType = (MenuItemProps & {
     type?: 'item';
 }) | (MenuSubmenuProps & {
     type?: 'submenu';
 });
-type MenuGroupProps = Omit<MenuItemProps$1, 'items'> & {
+type MenuGroupProps = Omit<MenuItemProps, 'items'> & {
     items?: MenuGroupItemType[];
 };
 declare const MenuGroup: React.FC<MenuGroupProps>;
@@ -110,21 +177,47 @@ type MenuItemType = (MenuGroupProps & {
     type?: 'group';
 }) | (MenuSubmenuProps & {
     type?: 'submenu';
-}) | (MenuItemProps$1 & {
+}) | (MenuItemProps & {
     type?: 'item';
 });
-interface Props$8 {
-    value?: any | any[];
-    defaultValue?: any | any[];
+interface Props$2 {
+    /**
+     * The currently selected value of the menu.
+     */
+    value?: any[];
+    /**
+     * The default value of the menu when initially rendered.
+     */
+    defaultValue?: any[];
+    /**
+     * An array of values that represent open submenus in the menu.
+     */
     openValues?: any[];
-    expandMode?: 'single' | 'multiple';
+    /**
+     * The expand mode of the menu, which can be 'single' or 'multiple'.
+     */
+    navMode?: 'single' | 'multiple';
+    /**
+     * The nav mode of the menu, which can be 'manual' or 'automatic'.
+     * Search for the last level of the menu and validate if the value matches.
+     */
     openMode?: 'manual' | 'automatic';
-    onChange?: (value: any | any[]) => void;
+    /**
+     * A callback function called when the selected values of the menu change.
+     */
+    onChange?: (value: any[]) => void;
+    /**
+     * A callback function called when submenus are opened.
+     */
     onOpen?: (values: any[]) => void;
-    onItemSelect?: (props: MenuItemProps$1) => void;
-}
-type NativeAttrs$2 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$8 | 'items'>;
-type MenuProps = Props$8 & NativeAttrs$2 & {
+    /**
+     * A callback function called when a menu item is selected.
+     * @param {MenuItemProps} props - The properties of the selected menu item.
+     */
+    onItemSelect?: (props: MenuItemProps) => void;
+}
+type NativeAttrs$2 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$2 | 'items'>;
+type MenuProps = Props$2 & NativeAttrs$2 & {
     items: MenuItemType[];
 };
 declare const Menu: React.FC<MenuProps>;
@@ -133,11 +226,11 @@ interface MenuContextValue {
     value: any;
     originalValue: any;
     openValues: any[];
-    expandMode: 'single' | 'multiple';
+    navMode: 'single' | 'multiple';
     openMode: 'manual' | 'automatic';
     onChange: (value: any) => void;
     onOpen: (values: any) => void;
-    onItemSelect: (props: MenuItemProps$1) => void;
+    onItemSelect: (props: MenuItemProps) => void;
 }
 declare const MenuContext: react.Context<MenuContextValue | null>;
 declare const useMenu: () => MenuContextValue;
@@ -147,104 +240,58 @@ declare const useMenuItemValue: () => string[];
 
 declare const getOpenValuesByPathname: (pathname: string) => string[];
 
-interface Props$7 {
+interface Props$1 {
+    /**
+     * The HTML element type or React component to render as the tab.
+     */
     as?: React.ElementType;
+    /**
+     * The value associated with the tab.
+     */
     value?: any;
+    /**
+     * Whether the tab can be closed.
+     */
     closable?: boolean;
+    /**
+     * Whether the tab is disabled.
+     */
     disabled?: boolean;
 }
-type NativeAttrs$1 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$7>;
-type TabProps = Props$7 & NativeAttrs$1;
-declare const Tab: react.ForwardRefExoticComponent<Props$7 & NativeAttrs$1 & {
+type NativeAttrs$1 = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$1>;
+type TabProps = Props$1 & NativeAttrs$1;
+declare const Tab: react.ForwardRefExoticComponent<Props$1 & NativeAttrs$1 & {
     children?: react.ReactNode;
 } & react.RefAttributes<HTMLDivElement>>;
 
 type TabsAlignmet = 'start' | 'center' | 'end' | 'stretch';
 
-interface Props$6 {
+interface Props {
+    /**
+     * The currently selected value of the tabs.
+     */
     value?: any;
+    /**
+     * The default value of the tabs when initially rendered.
+     */
     defaultValue?: any;
+    /**
+     * The alignment of the tabs.
+     */
     alignment?: TabsAlignmet;
+    /**
+     * A callback function called when the selected tab value changes.
+     */
     onChange?: (value: any) => void;
+    /**
+     * A callback function called when a tab is closed.
+     */
     onClose?: (value: any) => void;
 }
-type NativeAttrs = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props$6>;
-type TabsProps = Props$6 & NativeAttrs;
+type NativeAttrs = Omit<React.HTMLAttributes<HTMLDivElement>, keyof Props>;
+type TabsProps = Props & NativeAttrs;
 declare const Tabs: React.FC<TabsProps>;
 
-interface IDropEnumList {
-    dataEnum: object;
-    description: Map<any, Map<number, string>>;
-    width: number;
-    defaultValue: number;
-    onChange: (number: any) => void;
-}
-declare const DropEnumList: React.FC<IDropEnumList>;
-
-interface IBreadCrumbContext {
-    active: string;
-    setActive: (value: string) => void;
-    path: string;
-    setPath: (value: string) => void;
-    routes: {
-        route: string | -1;
-        title: string;
-    }[];
-    setRoutes: (value: {
-        route: string | -1;
-        title: string;
-    }[]) => void;
-    pathChild: string;
-    setPathChild: (value: string) => void;
-    goBack: boolean;
-    setGoBack: (value: boolean) => void;
-}
-declare const BreadCrumbContext: react.Context<IBreadCrumbContext>;
-interface Props$5 {
-    children: ReactNode;
-}
-declare const BreadCrumbContextProvider: ({ children }: Props$5) => react_jsx_runtime.JSX.Element;
-
-interface IDrawerContext {
-    active: boolean;
-    setActive: (value: boolean) => void;
-}
-declare const DrawerContext: react.Context<IDrawerContext>;
-interface Props$4 {
-    children: ReactNode;
-}
-declare const DrawerContextProvider: FC<Props$4>;
-
-interface GlobalProps {
-    children: ReactNode;
-}
-declare function GlobalProvider({ children }: GlobalProps): react_jsx_runtime.JSX.Element;
-
-interface HistoryPath {
-    path: string;
-    name: string;
-    date?: Date;
-}
-interface IHistoryContext {
-    list: HistoryPath[];
-    updateList: (list: HistoryPath) => void;
-}
-declare const HistoryContext: react.Context<IHistoryContext>;
-interface Props$3 {
-    children: React.ReactNode;
-}
-declare const HistoryContextProvider: ({ children }: Props$3) => react_jsx_runtime.JSX.Element;
-
-interface ISidebarMainContext {
-    open: boolean;
-    setOpen: (value: boolean) => void;
-}
-declare const SidebarMainContext: react.Context<ISidebarMainContext>;
-interface Props$2 {
-    children: ReactNode;
-}
-declare const SidebarMainContextProvider: ({ children }: Props$2) => react_jsx_runtime.JSX.Element;
-
 declare global {
     interface WindowEventMap {
         'local-storage': CustomEvent;
@@ -283,109 +330,4 @@ interface Helpers {
  */
 declare const useStep: (maxStep: number) => [number, Helpers];
 
-interface Props$1 {
-    title?: string;
-    paths?: {
-        route: string | -1;
-        title: string;
-    }[];
-}
-declare const AppBreadCrumb: ({ title, paths }: Props$1) => react_jsx_runtime.JSX.Element;
-declare const AppBreadCrumbNav: ({ paths, onPush, }: {
-    paths?: {
-        route: string;
-        title: string;
-    }[] | undefined;
-    onPush: (to: string | number) => void;
-}) => react_jsx_runtime.JSX.Element;
-
-type LoadingType = 'window' | 'page' | 'grid' | 'button' | 'card' | 'div' | 'none';
-/**
- * If the gridContent exists, render the loader in the gridContent, otherwise, if the reportContent
- * exists, render the loader in the reportContent, otherwise, render the loader in the current
- * component.
- * @returns A React component that is a portal.
- */
-declare const LoaderGrid: () => react_jsx_runtime.JSX.Element;
-interface ILoaderProps {
-    type?: LoadingType;
-    parent?: string;
-    minDuration?: number;
-}
-/**
- * It's a React component that renders a loading indicator in a parent element.
- * @param props - {type?: LoadingType; parent?: string; minDuration?: number;}
- * @returns A React component that is a function.
- */
-declare const AppLoader: FC<ILoaderProps>;
-
-interface CustomBtns {
-    title?: string;
-    render?: React.ReactNode;
-    Icon?: ({ className }: {
-        className: string;
-    }) => JSX.Element;
-    onAction?: () => void;
-}
-interface CustomExcel {
-    title: string;
-    classNameIcon: string;
-    onAction: () => void;
-}
-interface ICustomizeColumns {
-    disabled?: boolean;
-    className?: string;
-    entityType: number;
-    data: any[];
-    onFetched: (columns: any[]) => void;
-}
-interface NavOptionsProps {
-    exportExcel?: CustomExcel[];
-    customButtons?: CustomBtns[];
-    onCreate?: () => void;
-    onRefresh?: () => void;
-    onSelect?: () => void;
-    onClear?: () => void;
-    onExpandScreen?: () => void;
-}
-declare const NavOptions: FC<NavOptionsProps>;
-
-interface Props {
-    title?: string;
-}
-declare const Title: ({ title }: Props) => react_jsx_runtime.JSX.Element;
-
-declare const Breadcrumb: styled_components.StyledComponent<"div", any, {}, never>;
-declare const BreadCrumbTitle: styled_components.StyledComponent<"div", any, {}, never>;
-
-interface MenuItemProps {
-    type?: 'row' | 'col';
-    width?: string;
-}
-declare const MenuItem: styled_components.StyledComponent<react.ForwardRefExoticComponent<react_router_dom.LinkProps & react.RefAttributes<HTMLAnchorElement>>, any, MenuItemProps, never>;
-declare const MenuTitle: styled_components.StyledComponent<"p", any, {}, never>;
-
-interface NavbarProps {
-    gradient?: boolean;
-}
-declare const Navbar: styled_components.StyledComponent<"nav", any, NavbarProps, never>;
-
-declare const MenuOptions: styled_components.StyledComponent<"div", any, {}, never>;
-
-interface SidebarProps {
-    width?: string;
-    active?: boolean;
-    fixed?: boolean;
-    shadow?: boolean;
-}
-declare const ItemSidebar: styled_components.StyledComponent<"div", any, {}, never>;
-declare const SidebarNavigation: styled_components.StyledComponent<"nav", any, SidebarProps, never>;
-declare const ItemLinkSidebar: styled_components.StyledComponent<react.ForwardRefExoticComponent<react_router_dom.LinkProps & react.RefAttributes<HTMLAnchorElement>>, any, {}, never>;
-
-interface MainProps {
-    activeDrawer: boolean;
-}
-declare const Main: styled_components.StyledComponent<"main", any, MainProps, never>;
-declare const CloseIcon: styled_components.StyledComponent<"button", any, {}, never>;
-
-export { AppBreadCrumb, AppBreadCrumbNav, AppLoader, Badge, BadgeProps, BreadCrumbContext, BreadCrumbContextProvider, BreadCrumbTitle, Breadcrumb, Button, ButtonColor, ButtonProps, ButtonSize, ButtonVariant, Chip, ChipProps, CloseIcon, Collapse, CollapseContent, CollapseContentProps, CollapseContext, CollapseContextValue, CollapseProps, CollapseTrigger, CollapseTriggerProps, CustomBtns, CustomExcel, DrawerContext, DrawerContextProvider, DropEnumList, GlobalProps, GlobalProvider, HistoryContext, HistoryContextProvider, IBreadCrumbContext, ICustomizeColumns, ILoaderProps, ItemLinkSidebar, ItemSidebar, LoaderGrid, LoadingType, Main, Menu, MenuContext, MenuContextValue, MenuGroup, MenuGroupItemType, MenuGroupProps, MenuItem$1 as MenuItem, MenuItemProps$1 as MenuItemProps, MenuItemType, MenuItem as MenuItems, MenuOptions, MenuProps, MenuSubmenu, MenuSubmenuProps, MenuTitle, MenuValueContext, NavOptions, NavOptionsProps, Navbar, SidebarMainContext, SidebarMainContextProvider, SidebarNavigation, Tab, TabProps, Tabs, TabsAlignmet, TabsProps, Title, getOpenValuesByPathname, useCollapse, useLocalStorage, useMenu, useMenuItemValue, usePrevious, useStep };
+export { Badge, BadgeProps, Button, ButtonColor, ButtonProps, ButtonSize, ButtonVariant, Chip, ChipProps, Collapse, CollapseContent, CollapseContentProps, CollapseContext, CollapseContextValue, CollapseProps, CollapseTrigger, CollapseTriggerProps, Icon, IconProps, Menu, MenuContext, MenuContextValue, MenuGroup, MenuGroupItemType, MenuGroupProps, MenuItem, MenuItemProps, MenuItemType, MenuProps, MenuSubmenu, MenuSubmenuProps, MenuValueContext, Tab, TabProps, Tabs, TabsAlignmet, TabsProps, getOpenValuesByPathname, useCollapse, useLocalStorage, useMenu, useMenuItemValue, usePrevious, useStep };