@grasp-labs/ds-react-components 0.16.0 → 0.18.0

package/dist/components/{menu/Menu.d.ts → sidebar/Sidebar.d.ts}

@@ -1,45 +1,45 @@
 import { JSX, ReactElement, ReactNode } from 'react';
 /**
- * Represents a single route in the menu.
+ * Represents a single route in the sidebar.
  */
-export type MenuRoute = {
+export type SidebarRoute = {
     /** Unique path of the route, used as key and for navigation */
     path: string;
-    /** Display title of the menu item */
+    /** Display title of the sidebar item */
     title: string;
     /** Optional icon element to render next to the title */
     icon?: ReactNode;
     /** Nested children entries for submenus */
-    children?: MenuRoute[];
+    children?: SidebarRoute[];
     /** Permissions required to display this route */
     permissions?: string[];
-    /** Whether this route should be hidden from the menu */
-    hideMenu?: boolean;
+    /** Whether this route should be hidden from the sidebar */
+    isHidden?: boolean;
 };
 /**
- * Props for the `Menu` component.
+ * Props for the `Sidebar` component.
  */
-export type MenuProps = {
-    /** React element to display as the menu logo (e.g. an SVG component or img element) */
+export type SidebarProps = {
+    /** React element to display as the sidebar logo (e.g. an SVG component or img element) */
     logo: ReactElement;
-    /** Text to display in the footer */
-    footerText: string;
-    /** Array of routes to display in the menu */
-    routes: MenuRoute[];
+    /** Content to display in the footer */
+    footerContent: React.ReactNode;
+    /** Array of routes to display in the sidebar */
+    routes: SidebarRoute[];
     /** Current user permissions used to filter routes */
     permissions?: string[];
     /** Optional additional class names for styling */
     className?: string;
 };
 /**
- * `Menu` is a vertical navigation component that displays a header with a logo,
+ * `Sidebar` is a vertical navigation component that displays a header with a logo,
  * a list of navigable entries (filtered by permissions), and a footer.
  *
  * @example
  * ```tsx
- * <Menu
+ * <Sidebar
  *   logo={<MyLogo />}
- *   footerText="© 2025 My Company"
+ *   footerContent="© 2025 My Company"
  *   routes={[
  *     { path: "/dashboard", title: "Dashboard", icon: <DashboardIcon /> },
  *     { path: "/settings", title: "Settings", icon: <SettingsIcon />, permissions: ["admin"] }
@@ -48,4 +48,4 @@ export type MenuProps = {
  * />
  * ```
  */
-export declare const Menu: ({ logo, footerText, routes, permissions, className, }: MenuProps) => JSX.Element;
+export declare const Sidebar: ({ logo, footerContent, routes, permissions, className, }: SidebarProps) => JSX.Element;

package/dist/components/{menu/MenuEntry.d.ts → sidebar/SidebarEntry.d.ts}

@@ -1,33 +1,33 @@
 import { JSX, ReactNode } from 'react';
 /**
- * Represents a child route/entry in the menu hierarchy.
+ * Represents a child route/entry in the sidebar hierarchy.
  */
-export type MenuChild = {
+export type SidebarChild = {
     /** Unique path of the child entry (if navigable) */
     path?: string;
-    /** Display title of the menu item */
+    /** Display title of the sidebar item */
     title: string;
-    /** Optional icon for the menu item */
+    /** Optional icon for the sidebar item */
     icon?: ReactNode;
     /** Nested children for submenus */
-    children?: MenuChild[];
+    children?: SidebarChild[];
     /** Required permissions for the entry */
     permissions?: string[];
-    /** Whether this entry should be hidden from the menu */
-    hideMenu?: boolean;
+    /** Whether this entry should be hidden from the sidebar */
+    isHidden?: boolean;
 };
 /**
- * Props for the `MenuEntry` component.
+ * Props for the `SidebarEntry` component.
  */
-export type MenuEntryProps = {
+export type SidebarEntryProps = {
     /** Icon to display before the title */
     icon?: ReactNode;
-    /** Title text of the menu item */
+    /** Title text of the sidebar item */
     title: string;
     /** Path used for navigation when clicked (ignored if it has children) */
     path?: string;
-    /** Nested children menu entries */
-    childrenEntries?: MenuChild[];
+    /** Nested children sidebar entries */
+    childrenEntries?: SidebarChild[];
     /** Current user permissions for filtering children */
     permissions?: string[];
     /** The currently active path to highlight the entry */
@@ -40,15 +40,15 @@ export type MenuEntryProps = {
     depth?: number;
 };
 /**
- * `MenuEntry` renders a single menu item.
+ * `SidebarEntry` renders a single sidebar item.
  *
  * - If the entry has children, it can expand/collapse to reveal them.
  * - If it has a `path`, clicking navigates to that path via `onNavigate`.
- * - Entries are filtered by `permissions` and `hideMenu` before rendering.
+ * - Entries are filtered by `permissions` and `isHidden` before rendering.
  *
  * @example
  * ```tsx
- * <MenuEntry
+ * <SidebarEntry
  *   title="Settings"
  *   path="/settings"
  *   icon={<SettingsIcon />}
@@ -56,7 +56,7 @@ export type MenuEntryProps = {
  *   onNavigate={(path) => console.log("Navigate to:", path)}
  * />
  *
- * <MenuEntry
+ * <SidebarEntry
  *   title="Admin"
  *   icon={<AdminIcon />}
  *   childrenEntries={[
@@ -69,5 +69,5 @@ export type MenuEntryProps = {
  * />
  * ```
  */
-declare const MenuEntry: ({ icon, title, path, childrenEntries, permissions, className, activePath, onNavigate, depth, }: MenuEntryProps) => JSX.Element;
-export default MenuEntry;
+declare const SidebarEntry: ({ icon, title, path, childrenEntries, permissions, className, activePath, onNavigate, depth, }: SidebarEntryProps) => JSX.Element;
+export default SidebarEntry;

package/dist/components/sidebar/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Barrel exports for the Sidebar system.
+ * Allows importing the main Sidebar component.
+ *
+ * @example
+ * ```tsx
+ * import { Sidebar } from "@/components/Sidebar";
+ * ```
+ */
+export { Sidebar } from './Sidebar';
+export type { SidebarProps, SidebarRoute } from './Sidebar';