@starasia/admin 8.26.0 → 8.27.0

package/dist/entries/App/index.d.ts

@@ -20,3 +20,4 @@ export declare const App: React.MemoExoticComponent<({ router, menus, menuBottom
 export * from './hooks';
 export * from './context';
 export * from './sidebarBadges';
+export * from './sidebar';

package/dist/entries/App/sidebar.d.ts

@@ -0,0 +1,47 @@
+import { default as React, PropsWithChildren } from 'react';
+
+export interface SidebarContextValue {
+    /** Desktop sidebar collapsed (narrow rail) state. */
+    collapsed: boolean;
+    /** Set the desktop collapsed state directly (boolean or updater fn). */
+    setCollapsed: (value: boolean | ((prev: boolean) => boolean)) => void;
+    /** Toggle the desktop collapsed state. */
+    toggle: () => void;
+    /** Force-collapse the desktop sidebar to its narrow rail. */
+    collapse: () => void;
+    /** Force-expand the desktop sidebar to full width. */
+    expand: () => void;
+    /** Mobile drawer open state (sidebar slides over the content). */
+    mobileOpen: boolean;
+    /** Set the mobile drawer open state directly (boolean or updater fn). */
+    setMobileOpen: (value: boolean | ((prev: boolean) => boolean)) => void;
+    /** Open the mobile drawer. */
+    openMobile: () => void;
+    /** Close the mobile drawer. */
+    closeMobile: () => void;
+    /** Toggle the mobile drawer. */
+    toggleMobile: () => void;
+}
+export interface SidebarProviderProps extends PropsWithChildren {
+    /** Initial desktop collapsed state. @default false */
+    defaultCollapsed?: boolean;
+}
+/**
+ * Holds the AppLayout sidebar's collapse/expand (desktop) and drawer (mobile)
+ * state, so any component in the tree can read or control it via `useSidebar()`
+ * instead of prop-drilling. Mounted automatically by `<App>`, alongside
+ * `SidebarBadgesProvider` — consumers don't need to render it themselves.
+ */
+export declare const SidebarProvider: ({ children, defaultCollapsed, }: SidebarProviderProps) => React.JSX.Element;
+/**
+ * Read & control the AppLayout sidebar.
+ *
+ * ```tsx
+ * const { collapsed, toggle, expand, collapse, mobileOpen, openMobile } = useSidebar();
+ * <Button onClick={toggle}>{collapsed ? "Expand" : "Collapse"}</Button>
+ * ```
+ *
+ * Must be used inside `<App>` (which mounts `SidebarProvider`). Outside it the
+ * hook returns a no-op default (`collapsed: false`).
+ */
+export declare const useSidebar: () => SidebarContextValue;