@omnifyjp/ui 0.1.6 → 0.1.7

package/dist/components/radio-group.d.ts

@@ -2,7 +2,37 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as RadioGroupPrimitive from '@radix-ui/react-radio-group';
 
-declare function RadioGroup({ className, ...props }: React.ComponentProps<typeof RadioGroupPrimitive.Root>): react_jsx_runtime.JSX.Element;
-declare function RadioGroupItem({ className, ...props }: React.ComponentProps<typeof RadioGroupPrimitive.Item>): react_jsx_runtime.JSX.Element;
+type RadioGroupProps = React.ComponentProps<typeof RadioGroupPrimitive.Root>;
+/**
+ * Container for a set of mutually exclusive radio options.
+ * Use with {@link RadioGroupItem} to build single-selection groups.
+ *
+ * @example
+ * ```tsx
+ * <RadioGroup defaultValue="option-1">
+ *   <div className="flex items-center gap-2">
+ *     <RadioGroupItem value="option-1" id="opt1" />
+ *     <Label htmlFor="opt1">Option 1</Label>
+ *   </div>
+ *   <div className="flex items-center gap-2">
+ *     <RadioGroupItem value="option-2" id="opt2" />
+ *     <Label htmlFor="opt2">Option 2</Label>
+ *   </div>
+ * </RadioGroup>
+ * ```
+ */
+declare function RadioGroup({ className, ...props }: RadioGroupProps): react_jsx_runtime.JSX.Element;
+type RadioGroupItemProps = React.ComponentProps<typeof RadioGroupPrimitive.Item>;
+/**
+ * Individual radio option within a {@link RadioGroup}.
+ * Renders as a circular indicator that fills when selected.
+ *
+ * @example
+ * ```tsx
+ * <RadioGroupItem value="dark" id="theme-dark" />
+ * <Label htmlFor="theme-dark">Dark mode</Label>
+ * ```
+ */
+declare function RadioGroupItem({ className, ...props }: RadioGroupItemProps): react_jsx_runtime.JSX.Element;
 
-export { RadioGroup, RadioGroupItem };
+export { RadioGroup, RadioGroupItem, type RadioGroupItemProps, type RadioGroupProps };

package/dist/components/radio-group.js

@@ -1,4 +1,4 @@
-export { RadioGroup, RadioGroupItem } from '../chunk-6GCAG5FH.js';
+export { RadioGroup, RadioGroupItem } from '../chunk-BRSM3SZP.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=radio-group.js.map
 //# sourceMappingURL=radio-group.js.map

package/dist/components/rating.d.ts

@@ -1,14 +1,35 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 interface RatingProps {
+    /** Current rating value (e.g., `3` or `3.5` with half stars). */
     value?: number;
+    /** Callback fired when the user clicks a star. Receives the new rating number. */
     onChange?: (value: number) => void;
+    /** Maximum number of stars. Defaults to `5`. */
     max?: number;
+    /** Size of the star icons. Defaults to `"md"`. */
     size?: "sm" | "md" | "lg";
+    /** Whether the rating is display-only (non-interactive). Defaults to `false`. */
     readonly?: boolean;
+    /** Whether half-star ratings are enabled. Defaults to `false`. */
     allowHalf?: boolean;
+    /** Additional CSS class for the outer container. */
     className?: string;
 }
+/**
+ * Star rating component with hover preview and optional half-star support.
+ * Shows filled/empty/half star icons and displays the numeric value beside the stars.
+ *
+ * @example
+ * ```tsx
+ * const [rating, setRating] = useState(0);
+ *
+ * <Rating value={rating} onChange={setRating} max={5} />
+ *
+ * // Read-only display with half stars:
+ * <Rating value={3.5} readonly allowHalf />
+ * ```
+ */
 declare function Rating({ value, onChange, max, size, readonly, allowHalf, className, }: RatingProps): react_jsx_runtime.JSX.Element;
 
 export { Rating };

package/dist/components/rating.js

@@ -1,4 +1,4 @@
-export { Rating } from '../chunk-UCEUTKTQ.js';
+export { Rating } from '../chunk-HY4FVDA4.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=rating.js.map
 //# sourceMappingURL=rating.js.map

package/dist/components/resizable.d.ts

@@ -2,8 +2,33 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as ResizablePrimitive from 'react-resizable-panels';
 
+/**
+ * Resizable panel layout built on `react-resizable-panels`.
+ *
+ * Groups multiple `ResizablePanel` components separated by `ResizableHandle` drag handles.
+ * Supports horizontal (default) and vertical layouts via the `direction` prop.
+ *
+ * @example
+ * ```tsx
+ * <ResizablePanelGroup direction="horizontal">
+ *   <ResizablePanel defaultSize={50}>
+ *     <div className="p-4">Left panel</div>
+ *   </ResizablePanel>
+ *   <ResizableHandle withHandle />
+ *   <ResizablePanel defaultSize={50}>
+ *     <div className="p-4">Right panel</div>
+ *   </ResizablePanel>
+ * </ResizablePanelGroup>
+ * ```
+ */
 declare function ResizablePanelGroup({ className, ...props }: React.ComponentProps<typeof ResizablePrimitive.PanelGroup>): react_jsx_runtime.JSX.Element;
+/** Individual resizable panel. Use `defaultSize` (percentage) to set the initial width/height. */
 declare function ResizablePanel({ ...props }: React.ComponentProps<typeof ResizablePrimitive.Panel>): react_jsx_runtime.JSX.Element;
+/**
+ * Draggable handle between resizable panels.
+ *
+ * @param withHandle - When true, renders a visible grip icon on the handle for better discoverability.
+ */
 declare function ResizableHandle({ withHandle, className, ...props }: React.ComponentProps<typeof ResizablePrimitive.PanelResizeHandle> & {
     withHandle?: boolean;
 }): react_jsx_runtime.JSX.Element;

package/dist/components/resizable.js

@@ -1,4 +1,4 @@
-export { ResizableHandle, ResizablePanel, ResizablePanelGroup } from '../chunk-IJIGJGL5.js';
+export { ResizableHandle, ResizablePanel, ResizablePanelGroup } from '../chunk-FRKG7JQY.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=resizable.js.map
 //# sourceMappingURL=resizable.js.map

package/dist/components/scope-tree.d.ts

@@ -1,35 +1,78 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { LucideIcon } from 'lucide-react';
 
+/** A small badge displayed next to a tree node name. */
 interface ScopeTreeBadge {
+    /** Badge display text. */
     label: string;
+    /** Optional className to style this badge. */
     className?: string;
 }
+/** A node in the scope tree hierarchy. */
 interface ScopeTreeNode {
+    /** Unique identifier for this node, or `null` for root/global nodes. */
     id: string | null;
+    /** Display name of this scope. */
     name: string;
+    /** Scope type key (e.g. "global", "organization", "branch", "location"). Determines the icon. */
     type: string;
+    /** Optional child nodes for nested hierarchy. */
     children?: ScopeTreeNode[];
+    /** Optional badges displayed next to the node name. */
     badges?: ScopeTreeBadge[];
 }
+/** Represents the currently selected scope in the tree. */
 interface ScopeTreeSelectedScope {
+    /** The scope type key of the selected node. */
     type: string;
+    /** The ID of the selected node, or `null` for root/global nodes. */
     id: string | null;
 }
+/** Localizable labels for the scope tree. Currently reserved for future extensibility. */
 interface ScopeTreeLabels {
     /** No labels are required by default; provided for future extensibility. */
     [key: string]: string;
 }
 interface ScopeTreeProps {
+    /** Tree data: an array of root-level scope nodes. */
     nodes: ScopeTreeNode[];
+    /** The currently selected scope (type + id). Used for highlighting. */
     selectedScope?: ScopeTreeSelectedScope;
+    /** Callback when a node is clicked. */
     onSelect?: (scope: ScopeTreeSelectedScope) => void;
+    /** Localizable labels. Currently reserved for future extensibility. */
     labels?: Partial<ScopeTreeLabels>;
-    /** Default expansion depth. Nodes at depth < this value start expanded. Defaults to 1. */
+    /** Default expansion depth. Nodes at depth < this value start expanded. Defaults to `1`. */
     defaultExpandDepth?: number;
-    /** Custom icon map. Falls back to built-in icons for global/organization/branch/location. */
+    /** Custom icon map keyed by scope type. Falls back to built-in icons for global/organization/branch/location. */
     iconMap?: Record<string, LucideIcon>;
 }
+/**
+ * Hierarchical tree view for selecting organizational scopes (e.g. global,
+ * organization, branch, location). Nodes are expandable/collapsible with
+ * chevron icons. Each node type has a dedicated icon. Supports custom icons
+ * via `iconMap` and optional badges on nodes.
+ *
+ * @example
+ * ```tsx
+ * const nodes: ScopeTreeNode[] = [
+ *   {
+ *     id: null, name: "Global", type: "global",
+ *     children: [
+ *       { id: "org-1", name: "Acme Corp", type: "organization", children: [
+ *         { id: "br-1", name: "Tokyo HQ", type: "branch" },
+ *       ]},
+ *     ],
+ *   },
+ * ];
+ *
+ * <ScopeTree
+ *   nodes={nodes}
+ *   selectedScope={{ type: "branch", id: "br-1" }}
+ *   onSelect={(scope) => setSelected(scope)}
+ * />
+ * ```
+ */
 declare function ScopeTree({ nodes, selectedScope, onSelect, defaultExpandDepth, iconMap, }: ScopeTreeProps): react_jsx_runtime.JSX.Element;
 
 export { ScopeTree, type ScopeTreeBadge, type ScopeTreeLabels, type ScopeTreeNode, type ScopeTreeProps, type ScopeTreeSelectedScope };

package/dist/components/scope-tree.js

@@ -1,5 +1,5 @@
-export { ScopeTree } from '../chunk-MNAT3ZF6.js';
-import '../chunk-3TGN2DFB.js';
+export { ScopeTree } from '../chunk-EIY5FVSV.js';
+import '../chunk-OBZQTY3H.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=scope-tree.js.map
 //# sourceMappingURL=scope-tree.js.map

package/dist/components/scope-type-badge.d.ts

@@ -1,8 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { LucideIcon } from 'lucide-react';
 
+/** Custom style and icon overrides for a scope type badge. */
 interface ScopeTypeBadgeStyles {
+    /** Tailwind className string for the badge background, text, and border colors. */
     className: string;
+    /** Lucide icon component to display in the badge. */
     icon: LucideIcon;
 }
 interface ScopeTypeBadgeProps {
@@ -15,6 +18,18 @@ interface ScopeTypeBadgeProps {
     /** Override default styles and icon for the given type. */
     styles?: Partial<ScopeTypeBadgeStyles>;
 }
+/**
+ * Color-coded badge with an icon indicating a scope type. Ships with built-in
+ * styles for global (blue/Globe), organization (purple/Building2), branch
+ * (amber/GitBranch), and location (green/MapPin). Custom types fall back to
+ * global styling unless overridden via `styles`.
+ *
+ * @example
+ * ```tsx
+ * <ScopeTypeBadge type="organization" label="Organization" />
+ * <ScopeTypeBadge type="branch" label="Branch" />
+ * ```
+ */
 declare function ScopeTypeBadge({ type, label, className, styles: styleOverrides, }: ScopeTypeBadgeProps): react_jsx_runtime.JSX.Element;
 
 export { ScopeTypeBadge, type ScopeTypeBadgeProps, type ScopeTypeBadgeStyles };

package/dist/components/scope-type-badge.js

@@ -1,5 +1,5 @@
-export { ScopeTypeBadge } from '../chunk-4D6FDXCG.js';
-import '../chunk-3TGN2DFB.js';
+export { ScopeTypeBadge } from '../chunk-C7LPAIU6.js';
+import '../chunk-OBZQTY3H.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=scope-type-badge.js.map
 //# sourceMappingURL=scope-type-badge.js.map

package/dist/components/scroll-area.d.ts

@@ -2,7 +2,28 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as ScrollAreaPrimitive from '@radix-ui/react-scroll-area';
 
+/**
+ * Custom scrollable container with styled scrollbar built on Radix ScrollArea.
+ *
+ * Replaces native browser scrollbars with a thin, themed scrollbar.
+ * Includes a vertical `ScrollBar` by default. Add a horizontal `ScrollBar`
+ * as a child if needed.
+ *
+ * @example
+ * ```tsx
+ * <ScrollArea className="h-72 w-48 rounded-md border">
+ *   <div className="p-4">
+ *     {items.map((item) => (
+ *       <div key={item} className="py-2 text-sm">
+ *         {item}
+ *       </div>
+ *     ))}
+ *   </div>
+ * </ScrollArea>
+ * ```
+ */
 declare function ScrollArea({ className, children, ...props }: React.ComponentProps<typeof ScrollAreaPrimitive.Root>): react_jsx_runtime.JSX.Element;
+/** Styled scrollbar track and thumb. Set `orientation` to `"horizontal"` or `"vertical"` (default). */
 declare function ScrollBar({ className, orientation, ...props }: React.ComponentProps<typeof ScrollAreaPrimitive.ScrollAreaScrollbar>): react_jsx_runtime.JSX.Element;
 
 export { ScrollArea, ScrollBar };

package/dist/components/scroll-area.js

@@ -1,4 +1,4 @@
-export { ScrollArea, ScrollBar } from '../chunk-TMFQJ7E3.js';
+export { ScrollArea, ScrollBar } from '../chunk-JJSVA3TH.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=scroll-area.js.map
 //# sourceMappingURL=scroll-area.js.map

package/dist/components/select.d.ts

@@ -2,17 +2,51 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as SelectPrimitive from '@radix-ui/react-select';
 
+/**
+ * Select dropdown component built on Radix UI Select.
+ * Provides a styled, accessible dropdown for selecting a single value from a list.
+ *
+ * @example
+ * ```tsx
+ * <Select value={value} onValueChange={setValue}>
+ *   <SelectTrigger>
+ *     <SelectValue placeholder="Choose..." />
+ *   </SelectTrigger>
+ *   <SelectContent>
+ *     <SelectGroup>
+ *       <SelectLabel>Fruits</SelectLabel>
+ *       <SelectItem value="apple">Apple</SelectItem>
+ *       <SelectItem value="banana">Banana</SelectItem>
+ *     </SelectGroup>
+ *     <SelectSeparator />
+ *     <SelectGroup>
+ *       <SelectLabel>Vegetables</SelectLabel>
+ *       <SelectItem value="carrot">Carrot</SelectItem>
+ *     </SelectGroup>
+ *   </SelectContent>
+ * </Select>
+ * ```
+ */
 declare function Select({ ...props }: React.ComponentProps<typeof SelectPrimitive.Root>): react_jsx_runtime.JSX.Element;
+/** Groups related select items under an optional label. */
 declare function SelectGroup({ ...props }: React.ComponentProps<typeof SelectPrimitive.Group>): react_jsx_runtime.JSX.Element;
+/** Displays the currently selected value or a placeholder. */
 declare function SelectValue({ ...props }: React.ComponentProps<typeof SelectPrimitive.Value>): react_jsx_runtime.JSX.Element;
+/** Button that toggles the select dropdown open/closed. */
 declare const SelectTrigger: React.ForwardRefExoticComponent<Omit<SelectPrimitive.SelectTriggerProps & React.RefAttributes<HTMLButtonElement>, "ref"> & {
     size?: "sm" | "default";
 } & React.RefAttributes<HTMLButtonElement>>;
+/** Dropdown content container rendered in a portal. */
 declare function SelectContent({ className, children, position, ...props }: React.ComponentProps<typeof SelectPrimitive.Content>): react_jsx_runtime.JSX.Element;
+/** Non-interactive label rendered inside a SelectGroup. */
 declare function SelectLabel({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.Label>): react_jsx_runtime.JSX.Element;
+/** A selectable option within the dropdown. */
 declare function SelectItem({ className, children, ...props }: React.ComponentProps<typeof SelectPrimitive.Item>): react_jsx_runtime.JSX.Element;
+/** Visual separator between select groups or items. */
 declare function SelectSeparator({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.Separator>): react_jsx_runtime.JSX.Element;
+/** Scroll-up indicator shown when the list is scrollable. */
 declare function SelectScrollUpButton({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.ScrollUpButton>): react_jsx_runtime.JSX.Element;
+/** Scroll-down indicator shown when the list is scrollable. */
 declare function SelectScrollDownButton({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.ScrollDownButton>): react_jsx_runtime.JSX.Element;
 
 export { Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue };

package/dist/components/select.js

@@ -1,4 +1,4 @@
-export { Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue } from '../chunk-BOYSXIM3.js';
+export { Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue } from '../chunk-NNJTKHCE.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=select.js.map
 //# sourceMappingURL=select.js.map

package/dist/components/separator.d.ts

@@ -2,6 +2,23 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as SeparatorPrimitive from '@radix-ui/react-separator';
 
-declare function Separator({ className, orientation, decorative, ...props }: React.ComponentProps<typeof SeparatorPrimitive.Root>): react_jsx_runtime.JSX.Element;
+type SeparatorProps = React.ComponentProps<typeof SeparatorPrimitive.Root>;
+/**
+ * Visual divider between content sections, rendered as a horizontal or vertical line.
+ *
+ * @example
+ * ```tsx
+ * // Horizontal (default)
+ * <Separator />
+ *
+ * // Vertical divider in a flex row
+ * <div className="flex items-center gap-4">
+ *   <span>Left</span>
+ *   <Separator orientation="vertical" className="h-4" />
+ *   <span>Right</span>
+ * </div>
+ * ```
+ */
+declare function Separator({ className, orientation, decorative, ...props }: SeparatorProps): react_jsx_runtime.JSX.Element;
 
-export { Separator };
+export { Separator, type SeparatorProps };

package/dist/components/separator.js

@@ -1,4 +1,4 @@
-export { Separator } from '../chunk-ONAUEREV.js';
+export { Separator } from '../chunk-PGWNOZDX.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=separator.js.map
 //# sourceMappingURL=separator.js.map

package/dist/components/sheet.d.ts

@@ -2,15 +2,50 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import * as DialogPrimitive from '@radix-ui/react-dialog';
 
+/**
+ * Slide-out panel component built on Radix UI Dialog.
+ *
+ * A sheet slides in from the edge of the screen, ideal for navigation,
+ * filters, or supplementary content. Supports `top`, `right`, `bottom`,
+ * and `left` sides via the `side` prop on `SheetContent`.
+ *
+ * @example
+ * ```tsx
+ * <Sheet open={open} onOpenChange={setOpen}>
+ *   <SheetTrigger asChild>
+ *     <Button variant="outline">Open Sheet</Button>
+ *   </SheetTrigger>
+ *   <SheetContent side="right">
+ *     <SheetHeader>
+ *       <SheetTitle>Settings</SheetTitle>
+ *       <SheetDescription>
+ *         Adjust your preferences below.
+ *       </SheetDescription>
+ *     </SheetHeader>
+ *     <div className="p-4">Content here</div>
+ *     <SheetFooter>
+ *       <Button onClick={() => setOpen(false)}>Done</Button>
+ *     </SheetFooter>
+ *   </SheetContent>
+ * </Sheet>
+ * ```
+ */
 declare function Sheet({ ...props }: React.ComponentProps<typeof DialogPrimitive.Root>): react_jsx_runtime.JSX.Element;
+/** Element that opens the sheet when clicked. Use `asChild` to merge into your own button. */
 declare function SheetTrigger({ ...props }: React.ComponentProps<typeof DialogPrimitive.Trigger>): react_jsx_runtime.JSX.Element;
+/** Button that closes the sheet. Use `asChild` to merge into your own button. */
 declare function SheetClose({ ...props }: React.ComponentProps<typeof DialogPrimitive.Close>): react_jsx_runtime.JSX.Element;
+/** Sliding content panel. Set `side` to control which edge it slides from (default: `"right"`). */
 declare function SheetContent({ className, children, side, ...props }: React.ComponentProps<typeof DialogPrimitive.Content> & {
     side?: "top" | "right" | "bottom" | "left";
 }): react_jsx_runtime.JSX.Element;
+/** Container for SheetTitle and SheetDescription at the top of the sheet. */
 declare function SheetHeader({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Container for action buttons at the bottom of the sheet. Pushed to the bottom via `mt-auto`. */
 declare function SheetFooter({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Accessible title rendered inside SheetHeader. */
 declare function SheetTitle({ className, ...props }: React.ComponentProps<typeof DialogPrimitive.Title>): react_jsx_runtime.JSX.Element;
+/** Accessible description rendered inside SheetHeader below the title. */
 declare function SheetDescription({ className, ...props }: React.ComponentProps<typeof DialogPrimitive.Description>): react_jsx_runtime.JSX.Element;
 
 export { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger };

package/dist/components/sheet.js

@@ -1,4 +1,4 @@
-export { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger } from '../chunk-KOGOYUEE.js';
+export { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger } from '../chunk-JLTBUACL.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=sheet.js.map
 //# sourceMappingURL=sheet.js.map

package/dist/components/sidebar.d.ts

@@ -10,65 +10,158 @@ import '@radix-ui/react-separator';
 import '@radix-ui/react-tooltip';
 
 type SidebarContextProps = {
+    /** Current sidebar state: "expanded" or "collapsed". */
     state: "expanded" | "collapsed";
+    /** Whether the sidebar is open (desktop). */
     open: boolean;
+    /** Set the sidebar open state (desktop). */
     setOpen: (open: boolean) => void;
+    /** Whether the sidebar is open (mobile). */
     openMobile: boolean;
+    /** Set the sidebar open state (mobile). */
     setOpenMobile: (open: boolean) => void;
+    /** Whether the current viewport is mobile-sized. */
     isMobile: boolean;
+    /** Toggle the sidebar open/closed. */
     toggleSidebar: () => void;
 };
+/**
+ * Hook to access sidebar state and controls.
+ * Must be used within a {@link SidebarProvider}.
+ *
+ * @returns The sidebar context value including `state`, `open`, `toggleSidebar`, etc.
+ * @throws If used outside of a SidebarProvider.
+ */
 declare function useSidebar(): SidebarContextProps;
+/**
+ * Context provider that manages sidebar open/collapsed state, mobile detection,
+ * keyboard shortcut (Cmd/Ctrl+B), and cookie persistence.
+ * Wrap your layout with this provider before using any Sidebar components.
+ *
+ * @param defaultOpen - Initial open state for uncontrolled mode. Defaults to `true`.
+ * @param open - Controlled open state.
+ * @param onOpenChange - Callback when open state changes (controlled mode).
+ */
 declare function SidebarProvider({ defaultOpen, open: openProp, onOpenChange: setOpenProp, className, style, children, ...props }: React.ComponentProps<"div"> & {
+    /** Initial open state for uncontrolled usage. Defaults to `true`. */
     defaultOpen?: boolean;
+    /** Controlled open state. */
     open?: boolean;
+    /** Callback fired when the sidebar open state changes. */
     onOpenChange?: (open: boolean) => void;
 }): react_jsx_runtime.JSX.Element;
+/**
+ * Application sidebar with collapsible groups, menus, and responsive behavior.
+ * Built on top of Sheet for mobile and native sidebar for desktop.
+ *
+ * @param side - Which side of the viewport the sidebar appears on. Defaults to `"left"`.
+ * @param variant - Visual variant: `"sidebar"` (default), `"floating"`, or `"inset"`.
+ * @param collapsible - Collapse behavior: `"offcanvas"` (default), `"icon"`, or `"none"`.
+ *
+ * @example
+ * ```tsx
+ * <SidebarProvider>
+ *   <Sidebar>
+ *     <SidebarHeader>Logo</SidebarHeader>
+ *     <SidebarContent>
+ *       <SidebarGroup>
+ *         <SidebarGroupLabel>Menu</SidebarGroupLabel>
+ *         <SidebarMenu>
+ *           <SidebarMenuItem>
+ *             <SidebarMenuButton>Dashboard</SidebarMenuButton>
+ *           </SidebarMenuItem>
+ *         </SidebarMenu>
+ *       </SidebarGroup>
+ *     </SidebarContent>
+ *     <SidebarFooter>Footer</SidebarFooter>
+ *   </Sidebar>
+ * </SidebarProvider>
+ * ```
+ */
 declare function Sidebar({ side, variant, collapsible, className, children, ...props }: React.ComponentProps<"div"> & {
+    /** Which side the sidebar appears on. Defaults to `"left"`. */
     side?: "left" | "right";
+    /** Visual variant. Defaults to `"sidebar"`. */
     variant?: "sidebar" | "floating" | "inset";
+    /** Collapse behavior. Defaults to `"offcanvas"`. */
     collapsible?: "offcanvas" | "icon" | "none";
 }): react_jsx_runtime.JSX.Element;
+/** Button that toggles the sidebar open/closed. Renders a `PanelLeftIcon` ghost button. */
 declare function SidebarTrigger({ className, onClick, ...props }: React.ComponentProps<typeof Button>): react_jsx_runtime.JSX.Element;
+/** Thin vertical rail on the sidebar edge that toggles the sidebar on click. */
 declare function SidebarRail({ className, ...props }: React.ComponentProps<"button">): react_jsx_runtime.JSX.Element;
+/** Main content area that sits beside the sidebar. Use with `variant="inset"`. */
 declare function SidebarInset({ className, ...props }: React.ComponentProps<"main">): react_jsx_runtime.JSX.Element;
+/** Search input styled for use inside the sidebar. */
 declare function SidebarInput({ className, ...props }: React.ComponentProps<typeof Input>): react_jsx_runtime.JSX.Element;
+/** Container for the top section of the sidebar (logo, org selector, etc.). */
 declare function SidebarHeader({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Container for the bottom section of the sidebar (user menu, settings, etc.). */
 declare function SidebarFooter({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Horizontal separator styled with sidebar border color. */
 declare function SidebarSeparator({ className, ...props }: React.ComponentProps<typeof Separator>): react_jsx_runtime.JSX.Element;
+/** Scrollable content area between SidebarHeader and SidebarFooter. Houses SidebarGroup components. */
 declare function SidebarContent({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Logical grouping of sidebar items. Typically contains a SidebarGroupLabel and SidebarMenu. */
 declare function SidebarGroup({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Small heading label for a SidebarGroup (e.g. "Navigation", "Projects"). */
 declare function SidebarGroupLabel({ className, asChild, ...props }: React.ComponentProps<"div"> & {
     asChild?: boolean;
 }): react_jsx_runtime.JSX.Element;
+/** Action button positioned at the top-right of a SidebarGroup (e.g. "Add" button). */
 declare function SidebarGroupAction({ className, asChild, ...props }: React.ComponentProps<"button"> & {
     asChild?: boolean;
 }): react_jsx_runtime.JSX.Element;
+/** Wrapper for content inside a SidebarGroup, below the label. */
 declare function SidebarGroupContent({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Unordered list container for SidebarMenuItem components. */
 declare function SidebarMenu({ className, ...props }: React.ComponentProps<"ul">): react_jsx_runtime.JSX.Element;
+/** List item wrapper for a single sidebar menu entry. Contains a SidebarMenuButton. */
 declare function SidebarMenuItem({ className, ...props }: React.ComponentProps<"li">): react_jsx_runtime.JSX.Element;
 declare const sidebarMenuButtonVariants: (props?: ({
     variant?: "default" | "outline" | null | undefined;
     size?: "default" | "sm" | "lg" | null | undefined;
 } & class_variance_authority_types.ClassProp) | undefined) => string;
+/**
+ * Clickable button inside a SidebarMenuItem. Supports size/variant variants,
+ * active state highlighting, and an optional tooltip shown when collapsed to icon mode.
+ *
+ * @param isActive - Whether this item is the current active route.
+ * @param tooltip - Tooltip text or TooltipContent props shown in collapsed icon mode.
+ * @param asChild - Merge props onto the child element instead of rendering a button.
+ */
 declare function SidebarMenuButton({ asChild, isActive, variant, size, tooltip, className, ...props }: React.ComponentProps<"button"> & {
+    /** Render as child element via Radix Slot. */
     asChild?: boolean;
+    /** Whether this menu item represents the active route. */
     isActive?: boolean;
+    /** Tooltip shown when sidebar is collapsed to icon mode. */
     tooltip?: string | React.ComponentProps<typeof TooltipContent>;
 } & VariantProps<typeof sidebarMenuButtonVariants>): react_jsx_runtime.JSX.Element;
+/** Action button that appears to the right of a SidebarMenuButton (e.g. "more" or "delete"). */
 declare function SidebarMenuAction({ className, asChild, showOnHover, ...props }: React.ComponentProps<"button"> & {
     asChild?: boolean;
+    /** When true, only shows on hover/focus of the parent menu item. */
     showOnHover?: boolean;
 }): react_jsx_runtime.JSX.Element;
+/** Small count or status badge displayed to the right of a SidebarMenuButton. */
 declare function SidebarMenuBadge({ className, ...props }: React.ComponentProps<"div">): react_jsx_runtime.JSX.Element;
+/** Loading skeleton placeholder for a sidebar menu item. */
 declare function SidebarMenuSkeleton({ className, showIcon, ...props }: React.ComponentProps<"div"> & {
+    /** Whether to show an icon skeleton alongside the text skeleton. */
     showIcon?: boolean;
 }): react_jsx_runtime.JSX.Element;
+/** Nested sub-menu list with a left border, used for collapsible sub-navigation. */
 declare function SidebarMenuSub({ className, ...props }: React.ComponentProps<"ul">): react_jsx_runtime.JSX.Element;
+/** List item wrapper for a single sub-menu entry inside SidebarMenuSub. */
 declare function SidebarMenuSubItem({ className, ...props }: React.ComponentProps<"li">): react_jsx_runtime.JSX.Element;
+/** Clickable link/button inside a SidebarMenuSubItem. Renders as an anchor by default. */
 declare function SidebarMenuSubButton({ asChild, size, isActive, className, ...props }: React.ComponentProps<"a"> & {
+    /** Render as child element via Radix Slot. */
     asChild?: boolean;
+    /** Text size: `"sm"` (12px) or `"md"` (14px). Defaults to `"md"`. */
     size?: "sm" | "md";
+    /** Whether this sub-menu item represents the active route. */
     isActive?: boolean;
 }): react_jsx_runtime.JSX.Element;
 

package/dist/components/sidebar.js

@@ -1,10 +1,10 @@
-export { Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupAction, SidebarGroupContent, SidebarGroupLabel, SidebarHeader, SidebarInput, SidebarInset, SidebarMenu, SidebarMenuAction, SidebarMenuBadge, SidebarMenuButton, SidebarMenuItem, SidebarMenuSkeleton, SidebarMenuSub, SidebarMenuSubButton, SidebarMenuSubItem, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, useSidebar } from '../chunk-JJHKFW6P.js';
-import '../chunk-4CT5SCAH.js';
+export { Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupAction, SidebarGroupContent, SidebarGroupLabel, SidebarHeader, SidebarInput, SidebarInset, SidebarMenu, SidebarMenuAction, SidebarMenuBadge, SidebarMenuButton, SidebarMenuItem, SidebarMenuSkeleton, SidebarMenuSub, SidebarMenuSubButton, SidebarMenuSubItem, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, useSidebar } from '../chunk-JBQT2H4K.js';
+import '../chunk-C5NZAOA7.js';
 import '../chunk-WRCHR4AK.js';
-import '../chunk-VGQC333M.js';
+import '../chunk-JXGRW2MR.js';
 import '../chunk-3VU56V66.js';
-import '../chunk-KOGOYUEE.js';
-import '../chunk-ONAUEREV.js';
+import '../chunk-JLTBUACL.js';
+import '../chunk-PGWNOZDX.js';
 import '../chunk-Y65FNGEE.js';
 import '../chunk-DGPY4WP3.js';
 //# sourceMappingURL=sidebar.js.map