@foris/avocado-suite 1.10.0 → 1.10.2

package/dist/components/contextual-navigation/ContextualNavigation.d.ts

@@ -0,0 +1,4 @@
+import type { FC } from 'react';
+import type { ContextualNavigationProps } from './types';
+declare const ContextualNavigation: FC<ContextualNavigationProps>;
+export default ContextualNavigation;

package/dist/components/contextual-navigation/components/contextual-nav-control/ContextualNavControl.d.ts

@@ -0,0 +1,9 @@
+import type { FC, HTMLAttributes } from 'react';
+import type { ContextualNavigationItem } from '../../types';
+export type ContextualNavControlProps = HTMLAttributes<HTMLElement> & {
+    item: ContextualNavigationItem;
+    isActive: boolean;
+};
+/** A link when the destination has an `href` and is enabled; a button otherwise. */
+declare const ContextualNavControl: FC<ContextualNavControlProps>;
+export default ContextualNavControl;

package/dist/components/contextual-navigation/components/contextual-nav-control/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ContextualNavControl';

package/dist/components/contextual-navigation/components/contextual-nav-icon/ContextualNavIcon.d.ts

@@ -0,0 +1,12 @@
+import type { FC } from 'react';
+import type { IconTypes } from '../../../../../../avocado-icons';
+export type ContextualNavIconProps = {
+    name: IconTypes;
+    isActive: boolean;
+    isDisabled?: boolean;
+    showBadge?: boolean;
+    /** Without it the badge is decorative and hidden from assistive technology. */
+    badgeAriaLabel?: string;
+};
+declare const ContextualNavIcon: FC<ContextualNavIconProps>;
+export default ContextualNavIcon;

package/dist/components/contextual-navigation/components/contextual-nav-icon/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ContextualNavIcon';

package/dist/components/contextual-navigation/components/contextual-nav-item/ContextualNavItem.d.ts

@@ -0,0 +1,11 @@
+import type { FC } from 'react';
+import type { ContextualNavigationItem, ContextualNavigationProps } from '../../types';
+export type ContextualNavItemProps = {
+    item: ContextualNavigationItem;
+    activeId?: string;
+    isCollapsed?: boolean;
+    isMobileOverflowHidden?: boolean;
+    onItemClick?: ContextualNavigationProps['onItemClick'];
+};
+declare const ContextualNavItem: FC<ContextualNavItemProps>;
+export default ContextualNavItem;

package/dist/components/contextual-navigation/components/contextual-nav-item/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ContextualNavItem';

package/dist/components/contextual-navigation/components/contextual-nav-overflow/ContextualNavOverflow.d.ts

@@ -0,0 +1,10 @@
+import type { FC } from 'react';
+import type { ContextualNavigationItem, ContextualNavigationProps } from '../../types';
+export type ContextualNavOverflowProps = {
+    items: ContextualNavigationItem[];
+    activeId?: string;
+    label: string;
+    onItemClick?: ContextualNavigationProps['onItemClick'];
+};
+declare const ContextualNavOverflow: FC<ContextualNavOverflowProps>;
+export default ContextualNavOverflow;

package/dist/components/contextual-navigation/components/contextual-nav-overflow/index.d.ts

@@ -0,0 +1 @@
+export { default } from './ContextualNavOverflow';

package/dist/components/contextual-navigation/contextualNavigation.locale.d.ts

@@ -0,0 +1,14 @@
+export declare const CONTEXTUAL_NAVIGATION_STRINGS: {
+    en: {
+        navLabel: string;
+        expandNav: string;
+        collapseNav: string;
+        overflowLabel: string;
+    };
+    es: {
+        navLabel: string;
+        expandNav: string;
+        collapseNav: string;
+        overflowLabel: string;
+    };
+};

package/dist/components/contextual-navigation/hooks/useContextualNavigationCollapse.d.ts

@@ -0,0 +1,11 @@
+type UseContextualNavigationCollapseParams = {
+    collapsed?: boolean;
+    defaultCollapsed?: boolean;
+    persistenceKey?: string;
+    onCollapsedChange?: (collapsed: boolean) => void;
+};
+export declare const useContextualNavigationCollapse: ({ collapsed, defaultCollapsed, persistenceKey, onCollapsedChange, }: UseContextualNavigationCollapseParams) => {
+    collapsed: boolean;
+    toggleCollapsed: () => void;
+};
+export {};

package/dist/components/contextual-navigation/hooks/useContextualNavigationCollapse.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/contextual-navigation/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './ContextualNavigation';
+export type { ContextualNavigationProps, ContextualNavigationItem, } from './types';

package/dist/components/contextual-navigation/types.d.ts

@@ -0,0 +1,43 @@
+import type { MouseEvent, ReactNode } from 'react';
+import type { IconTypes } from '../../../../avocado-icons';
+export type ContextualNavigationItem = {
+    /** Unique id; matches `activeId` when this destination is current. */
+    id: string;
+    /** Visible label. */
+    label: string;
+    /** Leading icon. */
+    icon: IconTypes;
+    /** Destination URL. When set, the item renders as a link. */
+    href?: string;
+    /** Prevents activation and navigation. */
+    disabled?: boolean;
+    /** Shows a notification dot on the item. */
+    showBadge?: boolean;
+    /** Accessible name for the badge; required when `showBadge` is true. */
+    badgeAriaLabel?: string;
+};
+export type ContextualNavigationProps = {
+    /** Every destination, in groups separated by dividers on desktop. */
+    sections: ContextualNavigationItem[][];
+    /** Id of the current destination. */
+    activeId?: string;
+    /** Controlled collapsed state for the desktop sidebar. */
+    collapsed?: boolean;
+    /** Initial collapsed state when uncontrolled. */
+    defaultCollapsed?: boolean;
+    /** Called when the user toggles the desktop sidebar collapse control. */
+    onCollapsedChange?: (collapsed: boolean) => void;
+    /** `localStorage` key for persisting the collapsed state. */
+    persistenceKey?: string;
+    /**
+     * Called when an item is activated, before native navigation.
+     * Call `event.preventDefault()` to take over navigation.
+     */
+    onItemClick?: (item: ContextualNavigationItem, event: MouseEvent<HTMLElement>) => void;
+    /** Names the `nav` landmark — important when the page has more than one nav region. */
+    'aria-label'?: string;
+    /** Page content rendered beside or below the navigation. */
+    children: ReactNode;
+    /** Extra class for the root element. Not applied when every section is empty, since only `children` renders. */
+    className?: string;
+};

package/dist/components/contextual-navigation/utils/contextualNavigation.util.d.ts

@@ -0,0 +1,3 @@
+import type { ContextualNavigationItem } from '../types';
+/** Destinations that do not fit the mobile bar, in declaration order. */
+export declare const getMobileOverflowItems: (sections: ContextualNavigationItem[][]) => ContextualNavigationItem[];

package/dist/components/contextual-navigation/utils/contextualNavigation.util.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/dropzone/Dropzone.d.ts

@@ -0,0 +1,22 @@
+import { type FC } from 'react';
+import { type Accept } from 'react-dropzone';
+import type { DropzoneDisplay, DropzoneUploadStatus } from './dropzone.types';
+export type { DropzoneDisplay, DropzoneUploadStatus } from './dropzone.types';
+export interface DropzoneProps {
+    selectLabel: string;
+    dropHint: string;
+    activeLabel: string;
+    uploadingLabel: string;
+    uploadErrorLabel: string;
+    buttonLabel: string;
+    file: File | null;
+    uploadStatus?: DropzoneUploadStatus;
+    disabled?: boolean;
+    accept?: Accept;
+    display?: DropzoneDisplay;
+    onFileChange: (file: File | null) => void;
+    onRemove?: () => void;
+    className?: string;
+}
+declare const Dropzone: FC<DropzoneProps>;
+export default Dropzone;

package/dist/components/dropzone/DropzoneFileTag.d.ts

@@ -0,0 +1,8 @@
+import type { FC } from 'react';
+export interface DropzoneFileTagProps {
+    file: File;
+    onRemove: () => void;
+    stacked?: boolean;
+}
+declare const DropzoneFileTag: FC<DropzoneFileTagProps>;
+export default DropzoneFileTag;

package/dist/components/dropzone/DropzoneZoneBody.d.ts

@@ -0,0 +1,14 @@
+import type { FC, MouseEvent } from 'react';
+import type { DropzoneLabels, DropzoneUploadStatus } from './dropzone.types';
+export interface DropzoneZoneBodyProps {
+    disabled: boolean;
+    uploadStatus: DropzoneUploadStatus;
+    isDragActive: boolean;
+    file: File | null;
+    showUploadedChip: boolean;
+    labels: DropzoneLabels;
+    onOpenPicker: (event?: MouseEvent<HTMLElement>) => void;
+    onRemove: () => void;
+}
+declare const DropzoneZoneBody: FC<DropzoneZoneBodyProps>;
+export default DropzoneZoneBody;

package/dist/components/dropzone/dropzone.types.d.ts

@@ -0,0 +1,9 @@
+export type DropzoneUploadStatus = 'idle' | 'uploading' | 'error';
+export type DropzoneDisplay = 'zone' | 'button';
+export interface DropzoneLabels {
+    selectLabel: string;
+    dropHint: string;
+    activeLabel: string;
+    uploadingLabel: string;
+    uploadErrorLabel: string;
+}

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

@@ -0,0 +1,3 @@
+export { default as Dropzone } from './Dropzone';
+export type { DropzoneProps } from './Dropzone';
+export type { DropzoneDisplay, DropzoneUploadStatus } from './dropzone.types';

package/dist/components/file-upload/FileUpload.d.ts

@@ -0,0 +1,33 @@
+import type { FC } from 'react';
+import type { Accept } from 'react-dropzone';
+import { type CardNotificationProps } from '../card-notification/CardNotification';
+import { type DropzoneUploadStatus } from '../dropzone/Dropzone';
+export interface FileUploadProps {
+    title: string;
+    rulesTitle: string;
+    rules: string[];
+    helpTitle: string;
+    helpDescription: string;
+    templateLinkLabel: string;
+    templateHref?: string;
+    onTemplateLinkClick?: () => void;
+    selectLabel: string;
+    dropHint: string;
+    activeLabel: string;
+    uploadingLabel: string;
+    uploadErrorLabel: string;
+    buttonLabel: string;
+    file: File | null;
+    uploadStatus?: DropzoneUploadStatus;
+    disabled?: boolean;
+    accept?: Accept;
+    onFileChange: (file: File | null) => void;
+    onRemove?: () => void;
+    notificationVisible?: boolean;
+    notificationTitle?: string;
+    notificationDescription?: string;
+    notificationState?: CardNotificationProps['state'];
+    className?: string;
+}
+declare const FileUpload: FC<FileUploadProps>;
+export default FileUpload;

package/dist/components/file-upload/index.d.ts

@@ -0,0 +1,2 @@
+export { default as FileUpload } from './FileUpload';
+export type { FileUploadProps } from './FileUpload';

package/dist/index.d.ts

@@ -16,6 +16,8 @@ import DataCard from './components/data-card/DataCard';
 import DataTable from './components/DataTable/DataTable';
 import DatePicker from './components/date-picker/DatePicker';
 import Divider from './components/divider/Divider';
+import Dropzone from './components/dropzone/Dropzone';
+import FileUpload from './components/file-upload/FileUpload';
 import Donut from './components/donut/Donut';
 import DonutLabels from './components/donut/donut-labels/DonutLabels';
 import DonutLegend from './components/donut/donut-legend/DonutLegend';
@@ -58,13 +60,14 @@ import AccessPanel from './components/access-panel/AccessPanel';
 import AccountMenu from './components/account-menu/AccountMenu';
 import Header from './components/header/Header';
 import HeaderNavigation from './components/header-navigation';
+import ContextualNavigation from './components/contextual-navigation';
 import NavList from './components/nav-list';
 import { toast } from 'react-toastify';
 /**
  * Hooks
  */
 export { useFloatingPortal } from './hooks/useFloatingPortal';
-export { Banner, Beacon, Header, HeaderNavigation, Hotspot, 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, };
+export { Banner, Beacon, Header, HeaderNavigation, ContextualNavigation, Hotspot, NavList, Drawer, AccessPanel, AccountMenu, SidebarMenu, Weekly, WeeklyGroup, Accordion, Box, Breadcrumbs, Button, Card, CardAccordion, CardNotification, Checkbox, DataCard, DataTable, DatePicker, Divider, Dropzone, FileUpload, 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
  */
@@ -76,8 +79,11 @@ export type { CardAccordionProps } from './components/card-accordion/CardAccordi
 export type { CardNotificationProps } from './components/card-notification/CardNotification';
 export type { DataCardProps, DataCardV1Props, DataCardV1Variant, DataCardV2Props, DataCardV2HeaderStyle, DataCardV2Status, DataCardPaletteIndex, HeaderStatusColor, } from './components/data-card/DataCard';
 export type { DividerProps } from './components/divider/Divider';
+export type { DropzoneDisplay, DropzoneProps, DropzoneUploadStatus, } from './components/dropzone/Dropzone';
+export type { FileUploadProps } from './components/file-upload/FileUpload';
 export type { HeadingProps } from './components/heading/Heading';
 export type { HeaderNavigationProps, HeaderNavigationVisual, } from './components/header-navigation';
+export type { ContextualNavigationProps, ContextualNavigationItem, } from './components/contextual-navigation';
 export type { LinkProps } from './components/link/Link';
 export type { MenuItem } from './types/menu.types';
 export type { RoundButtonProps } from './components/round-button/RoundButton';