aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/icons/Icon.tsx
blob: 16019a6fb75d87ba3e150c39ab33bf88364c0a84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import { uniqueId } from 'lodash';
import * as React from 'react';

export interface IconProps extends React.HTMLAttributes<SVGSVGElement> {
  className?: string;
  fill?: string;
  size?: number;
  label?: React.ReactNode;
  description?: React.ReactNode;
}

interface Props extends React.HTMLAttributes<SVGSVGElement> {
  children: React.ReactNode;
  className?: string;
  size?: number;
  style?: React.CSSProperties;
  label?: React.ReactNode;
  description?: React.ReactNode;

  // try to avoid using these:
  width?: number;
  height?: number;
  viewBox?: string;
}

export default function Icon({
  children,
  className,
  size = 16,
  style,
  height = size,
  width = size,
  viewBox = '0 0 16 16',
  label,
  description,
  'aria-hidden': hidden,
  ...iconProps
}: Props) {
  const id = uniqueId('icon');
  return (
    <svg
      className={className}
      height={height}
      style={{
        fillRule: 'evenodd',
        clipRule: 'evenodd',
        strokeLinejoin: 'round',
        strokeMiterlimit: 1.41421,
        ...style,
      }}
      version="1.1"
      viewBox={viewBox}
      width={width}
      xmlnsXlink="http://www.w3.org/1999/xlink"
      xmlSpace="preserve"
      aria-describedby={description && !hidden ? id : undefined}
      {...iconProps}
    >
      {label && !hidden && <title>{label}</title>}
      {description && !hidden && <desc id={id}>{description}</desc>}
      {children}
    </svg>
  );
}