@me1a/ui 2.1.6 → 2.1.7

package/dist/organisms.d.mts

@@ -157,46 +157,188 @@ declare const SidebarMenuSubButton: React$1.ForwardRefExoticComponent<Omit<React
     isActive?: boolean;
 }, "ref"> & React$1.RefAttributes<HTMLAnchorElement>>;
 
+/**
+ * Context props for the Sidebar component that manages its state and behavior.
+ * This context provides the necessary state and methods to control the sidebar's
+ * expansion, collapse, and mobile responsiveness.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ */
 type SidebarContextProps = {
+    /** Current state of the sidebar - either expanded or collapsed */
     state: "expanded" | "collapsed";
+    /** Whether the sidebar is currently open */
     open: boolean;
+    /** Function to control the sidebar's open state */
     setOpen: (open: boolean) => void;
+    /** Whether the mobile sidebar is currently open */
     openMobile: boolean;
+    /** Function to control the mobile sidebar's open state */
     setOpenMobile: (open: boolean) => void;
+    /** Whether the sidebar is being viewed on a mobile device */
     isMobile: boolean;
+    /** Function to toggle the sidebar's state */
     toggleSidebar: () => void;
 };
+/**
+ * Props for the main Sidebar component.
+ * Extends the base div props and adds sidebar-specific configuration options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <Sidebar
+ *   side="left"
+ *   variant="sidebar"
+ *   collapsible="icon"
+ * >
+ *   <SidebarContent>...</SidebarContent>
+ * </Sidebar>
+ * ```
+ */
 type SidebarProps = React$1.ComponentProps<"div"> & {
+    /** Position of the sidebar relative to the main content */
     side?: "left" | "right";
+    /** Visual style variant of the sidebar */
     variant?: "sidebar" | "floating" | "inset";
+    /** Collapse behavior of the sidebar */
     collapsible?: "offcanvas" | "icon" | "none";
 };
+/**
+ * Props for the SidebarProvider component that manages sidebar state.
+ * Provides controlled and uncontrolled state management options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarProvider defaultOpen={true}>
+ *   <Sidebar>...</Sidebar>
+ * </SidebarProvider>
+ * ```
+ */
 type SidebarProviderProps = React$1.ComponentProps<"div"> & {
+    /** Initial open state for uncontrolled usage */
     defaultOpen?: boolean;
+    /** Controlled open state */
     open?: boolean;
+    /** Callback when open state changes */
     onOpenChange?: (open: boolean) => void;
 };
+/**
+ * Props for the SidebarMenuButton component.
+ * Extends button props with additional styling and behavior options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuButton
+ *   isActive={true}
+ *   tooltip="Dashboard"
+ * >
+ *   <DashboardIcon />
+ * </SidebarMenuButton>
+ * ```
+ */
 type SidebarMenuButtonProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Whether the button is currently active */
     isActive?: boolean;
+    /** Tooltip content or configuration */
     tooltip?: string | React$1.ComponentProps<typeof TooltipContent>;
 } & VariantProps<typeof sidebarMenuButtonVariants>;
+/**
+ * Props for the SidebarMenuAction component.
+ * Used for action buttons within the sidebar menu.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuAction showOnHover>
+ *   <PlusIcon />
+ * </SidebarMenuAction>
+ * ```
+ */
 type SidebarMenuActionProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Whether to only show the action on hover */
     showOnHover?: boolean;
 };
+/**
+ * Props for the SidebarMenuSubButton component.
+ * Used for secondary navigation items within the sidebar.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuSubButton
+ *   size="sm"
+ *   isActive={true}
+ *   href="/settings/profile"
+ * >
+ *   Profile Settings
+ * </SidebarMenuSubButton>
+ * ```
+ */
 type SidebarMenuSubButtonProps = React$1.ComponentProps<"a"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Size variant of the sub-button */
     size?: "sm" | "md";
+    /** Whether the sub-button is currently active */
     isActive?: boolean;
 };
+/**
+ * Props for the SidebarMenuSkeleton component.
+ * Used to show loading states in the sidebar menu.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuSkeleton showIcon />
+ * ```
+ */
 type SidebarMenuSkeletonProps = React$1.ComponentProps<"div"> & {
+    /** Whether to show an icon skeleton */
     showIcon?: boolean;
 };
+/**
+ * Props for the SidebarGroupLabel component.
+ * Used to display section labels within the sidebar.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarGroupLabel>Navigation</SidebarGroupLabel>
+ * ```
+ */
 type SidebarGroupLabelProps = React$1.ComponentProps<"div"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
 };
+/**
+ * Props for the SidebarGroupAction component.
+ * Used for action buttons within sidebar groups.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarGroupAction>
+ *   <SettingsIcon />
+ * </SidebarGroupAction>
+ * ```
+ */
 type SidebarGroupActionProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
 };
 

package/dist/organisms.d.ts

@@ -157,46 +157,188 @@ declare const SidebarMenuSubButton: React$1.ForwardRefExoticComponent<Omit<React
     isActive?: boolean;
 }, "ref"> & React$1.RefAttributes<HTMLAnchorElement>>;
 
+/**
+ * Context props for the Sidebar component that manages its state and behavior.
+ * This context provides the necessary state and methods to control the sidebar's
+ * expansion, collapse, and mobile responsiveness.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ */
 type SidebarContextProps = {
+    /** Current state of the sidebar - either expanded or collapsed */
     state: "expanded" | "collapsed";
+    /** Whether the sidebar is currently open */
     open: boolean;
+    /** Function to control the sidebar's open state */
     setOpen: (open: boolean) => void;
+    /** Whether the mobile sidebar is currently open */
     openMobile: boolean;
+    /** Function to control the mobile sidebar's open state */
     setOpenMobile: (open: boolean) => void;
+    /** Whether the sidebar is being viewed on a mobile device */
     isMobile: boolean;
+    /** Function to toggle the sidebar's state */
     toggleSidebar: () => void;
 };
+/**
+ * Props for the main Sidebar component.
+ * Extends the base div props and adds sidebar-specific configuration options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <Sidebar
+ *   side="left"
+ *   variant="sidebar"
+ *   collapsible="icon"
+ * >
+ *   <SidebarContent>...</SidebarContent>
+ * </Sidebar>
+ * ```
+ */
 type SidebarProps = React$1.ComponentProps<"div"> & {
+    /** Position of the sidebar relative to the main content */
     side?: "left" | "right";
+    /** Visual style variant of the sidebar */
     variant?: "sidebar" | "floating" | "inset";
+    /** Collapse behavior of the sidebar */
     collapsible?: "offcanvas" | "icon" | "none";
 };
+/**
+ * Props for the SidebarProvider component that manages sidebar state.
+ * Provides controlled and uncontrolled state management options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarProvider defaultOpen={true}>
+ *   <Sidebar>...</Sidebar>
+ * </SidebarProvider>
+ * ```
+ */
 type SidebarProviderProps = React$1.ComponentProps<"div"> & {
+    /** Initial open state for uncontrolled usage */
     defaultOpen?: boolean;
+    /** Controlled open state */
     open?: boolean;
+    /** Callback when open state changes */
     onOpenChange?: (open: boolean) => void;
 };
+/**
+ * Props for the SidebarMenuButton component.
+ * Extends button props with additional styling and behavior options.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuButton
+ *   isActive={true}
+ *   tooltip="Dashboard"
+ * >
+ *   <DashboardIcon />
+ * </SidebarMenuButton>
+ * ```
+ */
 type SidebarMenuButtonProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Whether the button is currently active */
     isActive?: boolean;
+    /** Tooltip content or configuration */
     tooltip?: string | React$1.ComponentProps<typeof TooltipContent>;
 } & VariantProps<typeof sidebarMenuButtonVariants>;
+/**
+ * Props for the SidebarMenuAction component.
+ * Used for action buttons within the sidebar menu.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuAction showOnHover>
+ *   <PlusIcon />
+ * </SidebarMenuAction>
+ * ```
+ */
 type SidebarMenuActionProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Whether to only show the action on hover */
     showOnHover?: boolean;
 };
+/**
+ * Props for the SidebarMenuSubButton component.
+ * Used for secondary navigation items within the sidebar.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuSubButton
+ *   size="sm"
+ *   isActive={true}
+ *   href="/settings/profile"
+ * >
+ *   Profile Settings
+ * </SidebarMenuSubButton>
+ * ```
+ */
 type SidebarMenuSubButtonProps = React$1.ComponentProps<"a"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
+    /** Size variant of the sub-button */
     size?: "sm" | "md";
+    /** Whether the sub-button is currently active */
     isActive?: boolean;
 };
+/**
+ * Props for the SidebarMenuSkeleton component.
+ * Used to show loading states in the sidebar menu.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarMenuSkeleton showIcon />
+ * ```
+ */
 type SidebarMenuSkeletonProps = React$1.ComponentProps<"div"> & {
+    /** Whether to show an icon skeleton */
     showIcon?: boolean;
 };
+/**
+ * Props for the SidebarGroupLabel component.
+ * Used to display section labels within the sidebar.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarGroupLabel>Navigation</SidebarGroupLabel>
+ * ```
+ */
 type SidebarGroupLabelProps = React$1.ComponentProps<"div"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
 };
+/**
+ * Props for the SidebarGroupAction component.
+ * Used for action buttons within sidebar groups.
+ *
+ * @url https://sergii-melnykov.github.io/ui/?path=/docs/organisms-sidebar--docs
+ *
+ * @example
+ * ```tsx
+ * <SidebarGroupAction>
+ *   <SettingsIcon />
+ * </SidebarGroupAction>
+ * ```
+ */
 type SidebarGroupActionProps = React$1.ComponentProps<"button"> & {
+    /** Whether to render as a child component */
     asChild?: boolean;
 };
 

package/dist/organisms.esm.js

@@ -1,2 +1,2 @@
-export{a as Drawer,d as DrawerClose,f as DrawerContent,j as DrawerDescription,h as DrawerFooter,g as DrawerHeader,e as DrawerOverlay,c as DrawerPortal,i as DrawerTitle,b as DrawerTrigger,J as DropdownMenu,T as DropdownMenuCheckboxItem,R as DropdownMenuContent,L as DropdownMenuGroup,S as DropdownMenuItem,V as DropdownMenuLabel,M as DropdownMenuPortal,O as DropdownMenuRadioGroup,U as DropdownMenuRadioItem,W as DropdownMenuSeparator,X as DropdownMenuShortcut,N as DropdownMenuSub,Q as DropdownMenuSubContent,P as DropdownMenuSubTrigger,K as DropdownMenuTrigger,m as Sidebar,u as SidebarContent,s as SidebarFooter,v as SidebarGroup,x as SidebarGroupAction,y as SidebarGroupContent,w as SidebarGroupLabel,r as SidebarHeader,q as SidebarInput,p as SidebarInset,z as SidebarMenu,D as SidebarMenuAction,E as SidebarMenuBadge,C as SidebarMenuButton,A as SidebarMenuItem,F as SidebarMenuSkeleton,G as SidebarMenuSub,I as SidebarMenuSubButton,H as SidebarMenuSubItem,l as SidebarProvider,o as SidebarRail,t as SidebarSeparator,n as SidebarTrigger,B as sidebarMenuButtonVariants,k as useSidebar}from'./chunk-LEUTYD7G.esm.js';import'./chunk-M4S5YZ56.esm.js';import'./chunk-3HTFCAYW.esm.js';import'./chunk-EBPUGBUT.esm.js';import'./chunk-C26U3FL4.esm.js';//# sourceMappingURL=organisms.esm.js.map
+export{a as Drawer,d as DrawerClose,f as DrawerContent,j as DrawerDescription,h as DrawerFooter,g as DrawerHeader,e as DrawerOverlay,c as DrawerPortal,i as DrawerTitle,b as DrawerTrigger,J as DropdownMenu,T as DropdownMenuCheckboxItem,R as DropdownMenuContent,L as DropdownMenuGroup,S as DropdownMenuItem,V as DropdownMenuLabel,M as DropdownMenuPortal,O as DropdownMenuRadioGroup,U as DropdownMenuRadioItem,W as DropdownMenuSeparator,X as DropdownMenuShortcut,N as DropdownMenuSub,Q as DropdownMenuSubContent,P as DropdownMenuSubTrigger,K as DropdownMenuTrigger,m as Sidebar,u as SidebarContent,s as SidebarFooter,v as SidebarGroup,x as SidebarGroupAction,y as SidebarGroupContent,w as SidebarGroupLabel,r as SidebarHeader,q as SidebarInput,p as SidebarInset,z as SidebarMenu,D as SidebarMenuAction,E as SidebarMenuBadge,C as SidebarMenuButton,A as SidebarMenuItem,F as SidebarMenuSkeleton,G as SidebarMenuSub,I as SidebarMenuSubButton,H as SidebarMenuSubItem,l as SidebarProvider,o as SidebarRail,t as SidebarSeparator,n as SidebarTrigger,B as sidebarMenuButtonVariants,k as useSidebar}from'./chunk-XJKHGY2A.esm.js';import'./chunk-M4S5YZ56.esm.js';import'./chunk-3HTFCAYW.esm.js';import'./chunk-EBPUGBUT.esm.js';import'./chunk-C26U3FL4.esm.js';//# sourceMappingURL=organisms.esm.js.map
 //# sourceMappingURL=organisms.esm.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@me1a/ui",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "private": false,
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",