mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-04 23:14:56 +01:00
68 lines
1.7 KiB
JavaScript
68 lines
1.7 KiB
JavaScript
import React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import classnames from 'classnames';
|
|
|
|
import Box from '../../ui/box/box';
|
|
|
|
import { Size, IconColor } from '../../../helpers/constants/design-system';
|
|
|
|
import { ICON_SIZES, ICON_NAMES } from './icon.constants';
|
|
|
|
export const Icon = ({
|
|
name,
|
|
size = Size.MD,
|
|
color = IconColor.inherit,
|
|
className,
|
|
style,
|
|
...props
|
|
}) => {
|
|
return (
|
|
<Box
|
|
color={color}
|
|
className={classnames(className, 'mm-icon', `mm-icon--size-${size}`)}
|
|
style={{
|
|
/**
|
|
* To reduce the possibility of injection attacks
|
|
* the icon component uses mask-image instead of rendering
|
|
* the svg directly.
|
|
*/
|
|
maskImage: `url('./images/icons/${name}.svg')`,
|
|
WebkitMaskImage: `url('./images/icons/${name}.svg')`,
|
|
...style,
|
|
}}
|
|
{...props}
|
|
/>
|
|
);
|
|
};
|
|
|
|
Icon.propTypes = {
|
|
/**
|
|
* The name of the icon to display. Should be one of ICON_NAMES
|
|
*/
|
|
name: PropTypes.oneOf(Object.values(ICON_NAMES)).isRequired,
|
|
/**
|
|
* The size of the Icon.
|
|
* Possible values could be SIZES.XS (12px), SIZES.SM (16px), SIZES.MD (20px), SIZES.LG (24px), SIZES.XL (32px),
|
|
* Default value is SIZES.MD (20px).
|
|
*/
|
|
size: PropTypes.oneOf(Object.values(ICON_SIZES)),
|
|
/**
|
|
* The color of the icon.
|
|
* Defaults to IconColor.inherit.
|
|
*/
|
|
color: PropTypes.oneOf(Object.values(IconColor)),
|
|
/**
|
|
* An additional className to apply to the icon.
|
|
*/
|
|
className: PropTypes.string,
|
|
/**
|
|
* Addition style properties to apply to the icon.
|
|
* The Icon component uses inline styles to apply the icon's mask-image so be wary of overriding
|
|
*/
|
|
style: PropTypes.object,
|
|
/**
|
|
* Icon accepts all the props from Box
|
|
*/
|
|
...Box.propTypes,
|
|
};
|