Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 0 additions & 217 deletions src/components/Avatar.tsx

This file was deleted.

120 changes: 120 additions & 0 deletions src/components/Avatar/UserAvatar.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
import useDefaultAvatars from '@hooks/useDefaultAvatars';
import useStyleUtils from '@hooks/useStyleUtils';
import useTheme from '@hooks/useTheme';

import type {AvatarSource} from '@libs/UserAvatarUtils';
import {getAvatar, optimizeAvatarSource, parseLetterAvatarURL} from '@libs/UserAvatarUtils';

import CONST from '@src/CONST';

import React from 'react';

import type {AvatarCommonProps} from './types';

import useAvatarLoadError from './hooks/useAvatarLoadError';
import AvatarContainer from './primitives/AvatarContainer';
import AvatarIcon from './primitives/AvatarIcon';
import AvatarImage from './primitives/AvatarImage';
import AvatarLetter from './primitives/AvatarLetter';

type UserAvatarProps = AvatarCommonProps & {
/** A fallback avatar icon to display when there is an error on loading avatar from remote URL. */
fallbackIcon?: AvatarSource;

/** Used to locate fallback icon in end-to-end tests. */
fallbackIconTestID?: string;

/** Owning account ID. Picks the default avatar when `source` is a default or absent. */
accountID: number;
};

/** Renders a user avatar, falling back to a default icon when no source is available. */
function UserAvatar({
source,
imageStyles,
iconAdditionalStyles,
containerStyles,
size = CONST.AVATAR_SIZE.DEFAULT,
fill,
fallbackIcon,
fallbackIconTestID = '',
accountID,
testID,
}: UserAvatarProps) {
const defaultAvatars = useDefaultAvatars();
const theme = useTheme();
const StyleUtils = useStyleUtils();
const {hasImageError, onImageError} = useAvatarLoadError(source);

const resolvedSource = getAvatar({avatarSource: source, accountID, defaultAvatars});

// Generated letter-avatar URLs are not fetched — their color and initials are parsed out and drawn locally.
const letterAvatar = parseLetterAvatarURL(resolvedSource);
if (letterAvatar) {
return (
<AvatarContainer

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the parent

        <AvatarContainer
            containerStyles={containerStyles}
            testID={testID}
        >

code is duplicated couple of times. If possible we should think of avoiding it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory we could, but with each Avatar primitive having slightly different logic I think this is more readable (avoiding conditionals in the code or pushing it into primitives)

containerStyles={containerStyles}
testID={testID}
>
<AvatarLetter
initials={letterAvatar.initials}
urlColors={letterAvatar.colors}
accountID={accountID}
size={size}
type={CONST.ICON_TYPE_AVATAR}
containerStyles={imageStyles}
containerAdditionalStyles={iconAdditionalStyles}
/>
</AvatarContainer>
);
}

const optimizedSource = optimizeAvatarSource(resolvedSource);
const useFallBackAvatar = hasImageError || !resolvedSource || resolvedSource === defaultAvatars.FallbackAvatar;
const fallbackAvatar = (fallbackIcon ?? defaultAvatars.FallbackAvatar) || defaultAvatars.FallbackAvatar;
const fallbackAvatarTestID = fallbackIconTestID || 'SvgFallbackAvatar Icon';
const avatarSource = useFallBackAvatar ? fallbackAvatar : (optimizedSource ?? fallbackAvatar);

if (typeof avatarSource === 'string') {
return (
<AvatarContainer
containerStyles={containerStyles}
testID={testID}
>
<AvatarImage
avatarSource={avatarSource}
size={size}
type={CONST.ICON_TYPE_AVATAR}
imageStyles={imageStyles}
imageContainerAdditionalStyles={iconAdditionalStyles}
onImageError={onImageError}
/>
</AvatarContainer>
);
}

let iconColors = null;
if (useFallBackAvatar && avatarSource === defaultAvatars.FallbackAvatar) {
iconColors = StyleUtils.getBackgroundColorAndFill(theme.buttonHoveredBG, theme.icon);
}

return (
<AvatarContainer
containerStyles={containerStyles}
testID={testID}
>
<AvatarIcon
avatarSource={avatarSource}
size={size}
type={CONST.ICON_TYPE_AVATAR}
iconContainerStyles={imageStyles}
iconAdditionalStyles={iconAdditionalStyles}
fallbackAvatarTestID={fallbackAvatarTestID}
iconColors={iconColors}
fill={iconColors?.fill ?? (hasImageError ? theme.offline : fill)}
/>
</AvatarContainer>
);
}

export default UserAvatar;
Loading
Loading