signal-desktop/ts/components/Avatar.tsx

// Copyright 2018-2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only

import * as React from 'react';
import classNames from 'classnames';

import { Spinner } from './Spinner';

import { getInitials } from '../util/getInitials';
import { LocalizerType } from '../types/Util';
import { ColorType } from '../types/Colors';

export enum AvatarSize {
  TWENTY_EIGHT = 28,
  THIRTY_TWO = 32,
  FIFTY_TWO = 52,
  EIGHTY = 80,
  NINETY_SIX = 96,
  ONE_HUNDRED_TWELVE = 112,
}

export type Props = {
  avatarPath?: string;
  color?: ColorType;
  loading?: boolean;

  conversationType: 'group' | 'direct';
  noteToSelf?: boolean;
  title: string;
  name?: string;
  phoneNumber?: string;
  profileName?: string;
  size: AvatarSize;

  onClick?: () => unknown;

  // Matches Popper's RefHandler type
  innerRef?: React.Ref<HTMLDivElement>;

  i18n: LocalizerType;
} & Pick<React.HTMLProps<HTMLDivElement>, 'className'>;

type State = {
  readonly imageBroken: boolean;
  readonly lastAvatarPath?: string;
};

export class Avatar extends React.Component<Props, State> {
  public handleImageErrorBound: () => void;

  public constructor(props: Props) {
    super(props);

    this.handleImageErrorBound = this.handleImageError.bind(this);

    this.state = {
      lastAvatarPath: props.avatarPath,
      imageBroken: false,
    };
  }

  public static getDerivedStateFromProps(props: Props, state: State): State {
    if (props.avatarPath !== state.lastAvatarPath) {
      return {
        ...state,
        lastAvatarPath: props.avatarPath,
        imageBroken: false,
      };
    }

    return state;
  }

  public handleImageError(): void {
    window.log.info(
      'Avatar: Image failed to load; failing over to placeholder'
    );
    this.setState({
      imageBroken: true,
    });
  }

  public renderImage(): JSX.Element | null {
    const { avatarPath, i18n, title } = this.props;
    const { imageBroken } = this.state;

    if (!avatarPath || imageBroken) {
      return null;
    }

    return (
      <img
        onError={this.handleImageErrorBound}
        alt={i18n('contactAvatarAlt', [title])}
        src={avatarPath}
      />
    );
  }

  public renderNoImage(): JSX.Element {
    const { conversationType, noteToSelf, size, title } = this.props;

    const initials = getInitials(title);
    const isGroup = conversationType === 'group';

    if (noteToSelf) {
      return (
        <div
          className={classNames(
            'module-avatar__icon',
            'module-avatar__icon--note-to-self',
            `module-avatar__icon--${size}`
          )}
        />
      );
    }

    if (!isGroup && initials) {
      return (
        <div
          className={classNames(
            'module-avatar__label',
            `module-avatar__label--${size}`
          )}
        >
          {initials}
        </div>
      );
    }

    return (
      <div
        className={classNames(
          'module-avatar__icon',
          `module-avatar__icon--${conversationType}`,
          `module-avatar__icon--${size}`
        )}
      />
    );
  }

  public renderLoading(): JSX.Element {
    const { size } = this.props;
    const svgSize = size < 40 ? 'small' : 'normal';

    return (
      <div className="module-avatar__spinner-container">
        <Spinner
          size={`${size - 8}px`}
          svgSize={svgSize}
          direction="on-avatar"
        />
      </div>
    );
  }

  public render(): JSX.Element {
    const {
      avatarPath,
      color,
      innerRef,
      loading,
      noteToSelf,
      onClick,
      size,
      className,
    } = this.props;
    const { imageBroken } = this.state;

    const hasImage = !noteToSelf && avatarPath && !imageBroken;

    if (![28, 32, 52, 80, 96, 112].includes(size)) {
      throw new Error(`Size ${size} is not supported!`);
    }

    let contents;

    if (loading) {
      contents = this.renderLoading();
    } else if (onClick) {
      contents = (
        <button
          type="button"
          className="module-avatar-button"
          onClick={onClick}
        >
          {hasImage ? this.renderImage() : this.renderNoImage()}
        </button>
      );
    } else {
      contents = hasImage ? this.renderImage() : this.renderNoImage();
    }

    return (
      <div
        className={classNames(
          'module-avatar',
          `module-avatar--${size}`,
          hasImage ? 'module-avatar--with-image' : 'module-avatar--no-image',
          !hasImage ? `module-avatar--${color}` : null,
          className
        )}
        ref={innerRef}
      >
        {contents}
      </div>
    );
  }
}