@sikka/hawa 0.26.29 → 0.26.31

package/dist/appLayout/index.d.ts

@@ -0,0 +1,126 @@
+import * as React from 'react';
+import React__default from 'react';
+
+type DirectionType = "rtl" | "ltr";
+
+type SubItem$1 = {
+    label?: string;
+    value?: any;
+    icon?: any;
+    action?: () => void;
+    onMiddleClick?: (e: any) => void;
+    highlighted?: boolean;
+    disabled?: boolean;
+    slug?: string;
+};
+type MenuItemType = {
+    icon?: React.ReactNode;
+    label?: string;
+    shortcut?: React.ReactNode;
+    badged?: boolean;
+    value?: any;
+    content?: any;
+    slug?: string;
+    end?: any;
+    presist?: boolean;
+    itemType?: "separator" | "label" | "custom";
+    action?: () => void;
+    highlighted?: boolean;
+    subitems?: SubItem$1[];
+    disabled?: boolean;
+    onMiddleClick?: (e: any) => void;
+    onClick?: any;
+};
+
+type ChipColors = "green" | "blue" | "red" | "yellow" | "orange" | "purple" | "cyan" | "hyper" | "oceanic";
+
+type AppSidebarItemProps = {
+    value: string;
+    slug?: string;
+    label: string;
+    badge?: {
+        label: string;
+        color: ChipColors;
+    };
+    icon?: any;
+    subitems?: SubItem[];
+    onClick?: (e: React.MouseEvent) => void;
+    onMouseDown?: (e: React.MouseEvent) => void;
+};
+type SubItem = {
+    value: string;
+    label: string;
+    slug?: string;
+    icon?: any;
+    onMouseDown?: (e: React.MouseEvent) => void;
+    onClick?: (e: React.MouseEvent) => void;
+};
+
+type AppLayoutTypes = {
+    /** a custom header to replace the logoLink & logoSymbol */
+    header?: React__default.ReactNode;
+    design?: "default";
+    /** The pages of the side drawer */
+    drawerItems: AppSidebarItemProps[];
+    /** The direction of the layout */
+    direction?: DirectionType;
+    /** The title of the current selected page, make sure it's the same as the drawerItem slug */
+    currentPage: string;
+    /** Specifies the title of the page. */
+    pageTitle?: string;
+    /** Specifies the symbol for the logo. */
+    logoSymbol?: any;
+    /** Specifies the link for the logo. */
+    logoLink?: string;
+    /** Specifies the text for the logo. */
+    logoText?: any;
+    /** Specifies the content to be displayed in the layout. */
+    children?: any;
+    /** Specifies whether to display the top bar. */
+    topBar?: boolean;
+    /** Specifies the username to be displayed. */
+    username?: string;
+    /** Specifies the user email to be displayed. */
+    email?: string;
+    /** Specifies the image for the avatar. */
+    avatarImage?: any;
+    /**
+     * Specifies the size of the drawer.
+     * - 'sm': Small.
+     * - 'md': Medium.
+     * - 'large': Large.
+     */
+    drawerSize?: "sm" | "md" | "large";
+    /** Specifies the menu items for the profile menu. */
+    profileMenuItems?: MenuItemType[];
+    /**
+     * Specifies the width of the profile menu.
+     * - 'default': Default width.
+     * - 'sm': Small width.
+     * - 'lg': Large width.
+     * - 'parent': Inherits width from parent element.
+     */
+    profileMenuWidth?: "default" | "sm" | "lg" | "parent";
+    /** Event handler for drawer expansion. */
+    onDrawerExpand?: (e: any) => void;
+    /** Specifies whether to keep the drawer open. */
+    keepOpen: boolean;
+    /** The method used to control whether the drawer is expanded or not. */
+    setKeepOpen: (value: boolean) => void;
+    /** Specifies additional actions for the drawer footer. */
+    DrawerFooterActions?: any;
+    /** Specifies the item that was clicked. */
+    clickedItem?: any;
+    /** Event handler for logo button click. */
+    onLogoClick?: () => void;
+    /** Text labels for various UI elements. */
+    texts?: {
+        /** Label for expand sidebar button. */
+        expandSidebar?: string;
+        /** Label for collapse sidebar button. */
+        collapseSidebar?: string;
+    };
+};
+declare const AppLayout: React__default.FunctionComponent<AppLayoutTypes>;
+
+export { AppLayout };