@yusr_systems/ui 3.0.0 → 3.1.1

package/dist/index.d.ts

@@ -13,6 +13,7 @@ import { ClassValue } from 'clsx';
 import { ColumnName } from '@yusr_systems/core';
 import { Combobox as Combobox_2 } from '@base-ui/react/combobox';
 import { Command as Command_2 } from 'cmdk';
+import { Context } from 'react';
 import * as ContextMenuPrimitive from '@radix-ui/react-context-menu';
 import { DayButton } from 'react-day-picker';
 import { DayPicker } from 'react-day-picker';
@@ -28,6 +29,7 @@ import * as DropdownMenuPrimitive from '@radix-ui/react-dropdown-menu';
 import { FilterCondition } from '@yusr_systems/core';
 import { FilterResult } from '@yusr_systems/core';
 import { JSX } from 'react/jsx-runtime';
+import { JSX as JSX_2 } from 'react';
 import * as LabelPrimitive from '@radix-ui/react-label';
 import { Locale } from 'react-day-picker';
 import { PayloadAction } from '@reduxjs/toolkit';
@@ -991,6 +993,8 @@ export declare function SideBarCompanyData({ company }: {
 
 export declare function SidebarContent({ className, ...props }: React_2.ComponentProps<"div">): JSX.Element;
 
+export declare const SidebarContext: Context<YusrSidBarProps | null>;
+
 declare type SidebarContextProps = {
     state: "expanded" | "collapsed";
     open: boolean;
@@ -1298,6 +1302,13 @@ declare interface UsernameObject {
 
 export declare function useSidebar(): SidebarContextProps;
 
+/**
+ * Returns the props of the nearest SidebarProvider.
+ * Must be used within a SidebarProvider.
+ * @returns {YusrSidBarProps} The props of the nearest SidebarProvider.
+ */
+export declare const useSidebarContext: () => YusrSidBarProps;
+
 export declare function useStorageFile<T>(setFormData: React.Dispatch<React.SetStateAction<T>>, fieldName: keyof T): {
     fileInputRef: RefObject<HTMLInputElement | null>;
     handleFileChange: (event: React.ChangeEvent<HTMLInputElement>) => Promise<void>;
@@ -1311,6 +1322,60 @@ export declare const useTheme: () => ThemeProviderState;
 
 export declare function YusrBusBackground(): JSX.Element;
 
+export declare type YusrSidBarProps = {
+    LinkComponent?: React.ElementType;
+    logos: {
+        logoFullDark: string;
+        logoFullLight: string;
+        logoOnlyDark: string;
+        logoOnlyLight: string;
+    };
+    displayCompany?: {
+        name: string;
+        logo: string;
+    };
+    navMain?: {
+        title: string;
+        url: string;
+        icon: JSX_2.Element;
+        hasAuth: boolean;
+    }[];
+    navSecondary?: {
+        title: string;
+        url: string;
+        icon: JSX_2.Element;
+    }[];
+};
+
+/**
+ * A sidebar component for Yusuf UI.
+ *
+ * It provides a sidebar that can be collapsed and opened with a button.
+ * The sidebar can be placed on the left or right side of the page.
+ * It also provides a context for the sidebar items to access the sidebar state.
+ *
+ * @param {React.ComponentProps<typeof Sidebar>} props The props for the sidebar.
+ * @param {YusrSidBarProps} props The props for the sidebar items.
+ * @param {PropsWithChildren} props The props with children for the sidebar.
+ * @param {React.ReactNode} [LinkComponent="a"] The component to use for the links in the sidebar.
+ * @param {React.ReactNode} [logos] The logos to display in the sidebar.
+ * @param {boolean} [displayCompany] Whether to display the company information in the sidebar.
+ * @param {YusrSidBarMainMenuProps["items"]} [navMain] The main navigation items for the sidebar.
+ * @param {YusrSidBarMainMenuProps["items"]} [navSecondary] The secondary navigation items for the sidebar.
+ * @param {React.ReactNode} [children] The children of the sidebar component.
+ */
+export declare function YusrSideBar({ LinkComponent, logos, displayCompany, navMain, navSecondary, children, ...props }: React.ComponentProps<typeof Sidebar> & YusrSidBarProps & PropsWithChildren): JSX.Element;
+
+export declare namespace YusrSideBar {
+    var Header: () => JSX.Element;
+    var Content: ({ LogoutHandler, }: {
+        LogoutHandler?: () => Promise<void>;
+    }) => JSX.Element;
+    var Footer: ({ loggedInUser }: {
+        loggedInUser: any;
+    }) => JSX.Element;
+}
+
 export declare function YusrSideBarMainMenu({ items, LinkComponent, }: {
     items: {
         title: string;