@foris/avocado-suite 1.8.15 → 1.8.16

package/dist/components/nav-list/NavList.d.ts

@@ -0,0 +1,17 @@
+import type { FC, MouseEvent } from 'react';
+import type { NavListItemData, NavListLeaf } from './types';
+export type NavListProps = {
+    /** Navigation entries. Top-level items may show an icon and may branch via `items`. */
+    items: NavListItemData[];
+    /** Extra class for the root `ul`. */
+    className?: string;
+    /** Names the `nav` landmark — important when the page has more than one nav region. */
+    'aria-label'?: string;
+    /**
+     * Called when a navigable item is clicked, before its native `href` navigation.
+     * Call `event.preventDefault()` to take over navigation (e.g. client-side routing).
+     */
+    onItemClick?: (item: NavListLeaf, event: MouseEvent<HTMLAnchorElement>) => void;
+};
+declare const NavList: FC<NavListProps>;
+export default NavList;

package/dist/components/nav-list/NavListContext.d.ts

@@ -0,0 +1,9 @@
+import type { MouseEvent } from 'react';
+import type { NavListLeaf } from './types';
+export type NavListContextValue = {
+    toggleBranch: (code: string) => void;
+    closeAll: () => void;
+    onItemClick?: (item: NavListLeaf, event: MouseEvent<HTMLAnchorElement>) => void;
+};
+export declare const NavListContext: import("react").Context<NavListContextValue | null>;
+export declare const useNavListContext: () => NavListContextValue;

package/dist/components/nav-list/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './NavList';
+export type { NavListProps } from './NavList';
+export type { NavListItemData, NavListLeaf } from './types';

package/dist/components/nav-list/nav-list-item/NavListItem.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { NavListItemData } from '../types';
+export type NavListItemProps = NavListItemData & {
+    depth?: number;
+    className?: string;
+    isOpen?: boolean;
+};
+declare const MemoNavListItem: import("react").NamedExoticComponent<NavListItemProps>;
+export default MemoNavListItem;

package/dist/components/nav-list/types.d.ts

@@ -0,0 +1,19 @@
+import type { IconTypes } from '../../../../avocado-icons';
+export type NavListLeaf = {
+    /** Unique id; also the key used to track which branch is open. */
+    code: string;
+    /** Visible label. */
+    name: string;
+    /** Destination URL. When set (and `canNavigate` isn't `false`) the item renders as a link. */
+    href?: string;
+    /** Render a static, non-clickable item even when `href` is present. Defaults to navigable. */
+    canNavigate?: boolean;
+};
+export type NavListItemData = NavListLeaf & {
+    /** Leading icon, shown only at the top level. */
+    icon?: IconTypes;
+    /** Children turn this entry into an expandable branch. */
+    items?: NavListLeaf[];
+    /** Expand this branch on mount. Only the first defaulted branch opens. */
+    defaultOpen?: boolean;
+};

package/dist/index.d.ts

@@ -55,12 +55,13 @@ import SidebarMenu from './components/sidebar-menu/SidebarMenu';
 import AccessPanel from './components/access-panel/AccessPanel';
 import AccountMenu from './components/account-menu/AccountMenu';
 import Header from './components/header/Header';
+import NavList from './components/nav-list';
 import { toast } from 'react-toastify';
 /**
  * Hooks
  */
 export { useFloatingPortal } from './hooks/useFloatingPortal';
-export { Banner, Header, Drawer, AccessPanel, AccountMenu, SidebarMenu, Weekly, WeeklyGroup, Accordion, Box, Breadcrumbs, Button, Card, CardAccordion, CardNotification, Checkbox, DataCard, DataTable, DatePicker, Divider, Donut, DonutLabels, DonutLegend, DropdownButton, Heading, Link, Loading, Menu, Modal, Pager, Pill, PreviewerMarkdown, Processing, ProgressBar, RadioButton, RoundButton, Select, SelectPagination, SkeletonBase, SkeletonCircle, Stepper, Switch, Tabs, Tag, Text, TextField, Textarea, ThemeProvider, ThemeStore, LocaleStore, Timer, Toaster, Tooltip, Table, toast, };
+export { Banner, Header, NavList, Drawer, AccessPanel, AccountMenu, SidebarMenu, Weekly, WeeklyGroup, Accordion, Box, Breadcrumbs, Button, Card, CardAccordion, CardNotification, Checkbox, DataCard, DataTable, DatePicker, Divider, Donut, DonutLabels, DonutLegend, DropdownButton, Heading, Link, Loading, Menu, Modal, Pager, Pill, PreviewerMarkdown, Processing, ProgressBar, RadioButton, RoundButton, Select, SelectPagination, SkeletonBase, SkeletonCircle, Stepper, Switch, Tabs, Tag, Text, TextField, Textarea, ThemeProvider, ThemeStore, LocaleStore, Timer, Toaster, Tooltip, Table, toast, };
 /**
  * Types
  */
@@ -82,6 +83,8 @@ export type { TimerTime } from './components/timer/Timer';
 export type { ModalProps } from './components/modal/Modal';
 export type { AccountMenuFooterAction, AccountMenuProps, } from './components/account-menu/AccountMenu';
 export type { DrawerProps } from './components/drawer/Drawer';
+export type { NavListProps } from './components/nav-list';
+export type { NavListItemData, NavListLeaf } from './components/nav-list/types';
 export type { PillProps } from './components/Pill/Pill';
 export type { PreviewerMarkdownProps } from './components/previewer-markdown/PreviewerMarkdown';
 export type { ThemeMode, Theme } from './types/theme.types';