import { ReactNode } from 'react';
import { To } from 'react-router-dom';
import { MenuType } from '../types/MenuType';
import { SxProps } from '@mui/system';
import { Theme } from '@mui/material';
export interface IMenuOption {
    /**
     * Unique identifier for the menu option
     */
    id: string;
    /**
     * Text to display for the menu option
     */
    label: string | ReactNode | Array<ReactNode>;
    /**
     * Where the menu option should be displayed
     */
    includeOnMenus: MenuType[];
    /**
     * Display order for the menu option. Lower numbers are displayed first.
     */
    index: number;
    /**
     * Whether the menu option is a divider
     */
    divider?: boolean;
    /**
     * Icon to display for the menu option
     */
    icon?: ReactNode;
    /**
     * Link to navigate to when the menu option is clicked
     * Mutually exclusive with `action`
     * Can be a string, a react-router To object, or an object with pathname and optional state
     */
    link?: To | {
        pathname: string;
        state?: unknown;
    };
    /**
     * Function to execute when the menu option is clicked
     * Mutually exclusive with `link`
     * @returns void
     */
    action?: () => void;
    /**
     * Whether the menu option requires authentication
     * true = requires authentication
     * false = requires unauthenticated
     * undefined = always show
     */
    requiresAuth: boolean | undefined;
    /**
     * Whether the menu option requires the user to be a global admin
     * true = only show to global admins
     * undefined/false = no admin requirement
     */
    requiresAdmin?: boolean;
    /**
     * Custom filter function to determine if the menu option should be displayed
     * @param option - The menu option to filter
     * @returns boolean
     */
    filter?: (option: IMenuOption) => boolean;
    /**
     * Additional CSS properties
     */
    additionalSx?: SxProps<Theme>;
    /**
     * Additional CSS properties for the side menu variant
     */
    sideSx?: SxProps<Theme>;
    /**
     * Additional CSS properties for the side menu variant Icon sub item
     */
    sideIconSx?: SxProps<Theme>;
    /**
     * Additional CSS properties for the side menu variant Text sub item
     */
    sideTextSx?: SxProps<Theme>;
}
//# sourceMappingURL=IMenuOption.d.ts.map