/**
 * Copyright IBM Corp. 2024, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import React from 'react';
import '../../global/js/utils/props-helper';
/**
 * TODO: A description of the component.
 */
type BackgroundColor = 'order-1-cyan' | 'order-2-gray' | 'order-3-green' | 'order-4-magenta' | 'order-5-purple' | 'order-6-teal' | 'order-7-cyan' | 'order-8-gray' | 'order-9-green' | 'order-10-magenta' | 'order-11-purple' | 'order-12-teal';
type Size = 'xl' | 'lg' | 'md' | 'sm';
type TooltipAlignment = 'top' | 'top-left' | 'top-right' | 'bottom' | 'bottom-left' | 'bottom-right' | 'left' | 'right';
type ImageProps = {
    /**
     * When passing the image prop, supply a full path to the image to be displayed.
     */
    image: string;
    /**
     * When passing the image prop use the imageDescription prop to describe the image for screen reader.
     */
    imageDescription: string;
} | {
    image?: never;
    imageDescription?: never;
};
type UserAvatarBaseProps = {
    /**
     * Provide the background color need to be set for UserAvatar.
     */
    backgroundColor?: BackgroundColor;
    /**
     * Provide an optional class to be applied to the containing node.
     */
    className?: string;
    /**
     * When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name.
     */
    name?: string;
    /**
     * Provide a custom icon to use if you need to use an icon other than the default one
     */
    renderIcon?: React.ElementType | string;
    /**
     * Set the size of the avatar circle
     */
    size?: Size;
    /**
     * Specify how the trigger should align with the tooltip
     */
    tooltipAlignment?: TooltipAlignment;
    /**
     * Pass in the display name to have it shown on hover
     */
    tooltipText?: string;
};
type UserAvatarProps = UserAvatarBaseProps & ImageProps;
export declare const UserAvatar: React.ForwardRefExoticComponent<UserAvatarProps & React.RefAttributes<HTMLDivElement>>;
export {};
//# sourceMappingURL=UserAvatar.d.ts.map