@stanfordspezi/spezi-web-design-system/dist/src/molecules/DashboardLayout/UserMenuItem.d.ts

Stanford Biodesign Digital Health Spezi Web Design System

import { ButtonProps } from '../../components/Button';
import { Nil } from '../../utils/misc';
type UserMenuItemProps = Omit<ButtonProps, "name"> & {
    /**
     * User's name to display
     */
    name: Nil<string>;
    /**
     * User's avatar image URL
     */
    img: Nil<string>;
};
/**
 * A component for displaying user information in the dashboard aside.
 * Shows the user's avatar and name, and can be clicked to trigger an action.
 *
 * Combine it with the {@link DropdownMenu} to create an interactive user menu.
 *
 * @example
 * ```tsx
 * <UserMenuItem
 *   name="John Doe"
 *   avatar="/path/to/avatar.jpg"
 * />
 * ```
 */
export declare const UserMenuItem: ({ name, img, ...props }: UserMenuItemProps) => import("react").JSX.Element;
export {};