/** * Copyright IBM Corp. 2021, 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 '../../global/js/utils/props-helper'; import { PopoverAlignment } from '@carbon/react'; import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon'; import React from 'react'; 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 UserProfileImageBaseProps = { /** * The background color passed should match one of the background colors in the library documentation: * https://pages.github.ibm.com/carbon/ibm-products/patterns/user-profile-images/ */ backgroundColor?: string; /** * Provide an optional class to be applied to the containing node. */ className?: string; /** * Provide a custom icon to use if you need to use an icon other than the included ones */ icon?: () => CarbonIconType | null; /** * When passing the initials prop, either send the initials to be used or the user's display name. The first two capital letters of the display name will be used as the initials. */ initials?: string; /** * When passing the kind prop, use either "user" or "group". The values match up to the Carbon Library icons. */ kind?: 'user' | 'group'; /** * Set the size of the avatar circle */ size: 'xl' | 'lg' | 'md'; /** * Set theme in which the component will be rendered */ theme: 'light' | 'dark'; /** * Specify how the trigger should align with the tooltip */ tooltipAlignment?: PopoverAlignment; /** * Pass in the display name to have it shown on hover */ tooltipText?: string; }; export type UserProfileImageProps = UserProfileImageBaseProps & imageProps; /** * The user profile avatar allows for an image of the user to be displayed by passing in the image prop. By default the component will display a user icon on a blue background. * @deprecated This component is deprecated. */ export declare const UserProfileImage: React.ForwardRefExoticComponent>; export {}; //# sourceMappingURL=UserProfileImage.d.ts.map