aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/sonar-aligned/components/controls/HelpTooltip.tsx
blob: 5b62130d27b54ffb84e29acfc66b7120c7004c81 (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
/*
 * 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 classNames from 'classnames';
import { HelperHintIcon } from 'design-system';
import * as React from 'react';
import Tooltip, { Placement } from '../../../components/controls/Tooltip';
import { translate } from '../../../helpers/l10n';

interface Props {
  'aria-label'?: string;
  children?: React.ReactNode;
  className?: string;
  'data-testid'?: string;
  overlay: React.ReactNode;
  placement?: Placement;
}

const DEFAULT_SIZE = 12;

export default function HelpTooltip(props: Readonly<Props>) {
  const { overlay, placement, children } = props;
  return (
    <div
      className={classNames(
        'it__help-tooltip sw-inline-flex sw-items-center sw-align-middle',
        props.className,
      )}
    >
      <Tooltip mouseLeaveDelay={0.25} overlay={overlay} placement={placement}>
        <span
          aria-label={props['aria-label']}
          className="sw-inline-flex sw-items-center"
          data-testid={props['data-testid'] ?? 'help-tooltip-activator'}
        >
          {children ?? (
            <HelperHintIcon
              aria-label={translate('help')}
              description={overlay}
              height={DEFAULT_SIZE}
              width={DEFAULT_SIZE}
            />
          )}
        </span>
      </Tooltip>
    </div>
  );
}