mastodon/app/javascript/glitch/components/common/icon/index.js

//  <CommonIcon>
//  ========

//  For code documentation, please see:
//  https://glitch-soc.github.io/docs/javascript/glitch/common/icon

//  For more information, please contact:
//  @kibi@glitch.social

//  * * * * * * *  //

//  Imports
//  -------

//  Package imports.
import classNames from 'classnames';
import React from 'react';
import PropTypes from 'prop-types';

//  Stylesheet imports.
import './style';

//  * * * * * * *  //

//  The component
//  -------------

const CommonIcon = ({
  className,
  name,
  proportional,
  title,
  ...others
}) => name ? (
  <span
    className={classNames('glitch', 'glitch__common__icon', className)}
    {...others}
  >
    <span
      aria-hidden
      className={`fa ${proportional ? '' : 'fa-fw'} fa-${name} icon\fa`}
      {...(title ? { title } : {})}
    />
    {title ? (
      <span className='_for-screenreader'>{title}</span>
    ) : null}
  </span>
) : null;

//  Props.
CommonIcon.propTypes = {
  className: PropTypes.string,
  name: PropTypes.string,
  proportional: PropTypes.bool,
  title: PropTypes.string,
};

//  Export.
export default CommonIcon;