mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-26 12:29:06 +01:00
33cd2c7c18
* added deprecation message above SiteIcon * fix eslint * Some small updates to show correct code formatting and removing params --------- Co-authored-by: georgewrmarshall <george.marshall@consensys.net>
44 lines
1.5 KiB
JavaScript
44 lines
1.5 KiB
JavaScript
import React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import IconBorder from '../icon-border';
|
|
import IconWithFallback from '../icon-with-fallback';
|
|
|
|
/**
|
|
* @deprecated `<SiteIcon />` has been deprecated in favor of the new `<AvatarFavicon>` component from the component-library.
|
|
* Please update your code to use the new <AvatarFavicon> component instead, which can be found at ./ui/components/component-library/avatar-favicon.js.
|
|
* You can find documentation for the new AvatarFavicon component in the MetaMask Storybook:
|
|
* {@link https://metamask.github.io/metamask-storybook/?path=/story/components-componentlibrary-avatarfavicon--default-story}
|
|
* Help to replace `SiteIcon` with `AvatarFavicon` by submitting a PR
|
|
*/
|
|
|
|
export default function SiteIcon({ icon = null, name = '', size, className }) {
|
|
const iconSize = Math.floor(size * 0.75);
|
|
return (
|
|
<IconBorder size={size} className={className}>
|
|
<IconWithFallback icon={icon} name={name} size={iconSize} />
|
|
</IconBorder>
|
|
);
|
|
}
|
|
|
|
SiteIcon.propTypes = {
|
|
/**
|
|
* Additional className to add to the root element of SiteIcon.
|
|
*/
|
|
className: PropTypes.string,
|
|
/**
|
|
* The img src of the icon.
|
|
* Used in IconWithFallback
|
|
*/
|
|
icon: PropTypes.string,
|
|
/**
|
|
* The name of the icon also used for the alt tag of the image and fallback letter.
|
|
* Used in IconWithFallback
|
|
*/
|
|
name: PropTypes.string,
|
|
/**
|
|
* The size of the icon.
|
|
* Used in IconWithFallback
|
|
*/
|
|
size: PropTypes.number.isRequired,
|
|
};
|