You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

HelpTooltip.tsx 2.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. /*
  2. * SonarQube
  3. * Copyright (C) 2009-2022 SonarSource SA
  4. * mailto:info AT sonarsource DOT com
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 3 of the License, or (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public License
  17. * along with this program; if not, write to the Free Software Foundation,
  18. * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19. */
  20. import classNames from 'classnames';
  21. import * as React from 'react';
  22. import { colors } from '../../app/theme';
  23. import HelpIcon from '../icons/HelpIcon';
  24. import { IconProps } from '../icons/Icon';
  25. import './HelpTooltip.css';
  26. import Tooltip, { Placement } from './Tooltip';
  27. interface Props extends Pick<IconProps, 'size'> {
  28. className?: string;
  29. children?: React.ReactNode;
  30. onShow?: () => void;
  31. overlay: React.ReactNode;
  32. placement?: Placement;
  33. ariaLabel?: string;
  34. ariaLabelledby?: string;
  35. }
  36. const DEFAULT_SIZE = 12;
  37. export default function HelpTooltip({
  38. size = DEFAULT_SIZE,
  39. ariaLabel,
  40. ariaLabelledby,
  41. ...props
  42. }: Props) {
  43. const role = ariaLabel || ariaLabelledby ? 'note' : undefined;
  44. return (
  45. <div
  46. className={classNames('help-tooltip', props.className)}
  47. aria-labelledby={ariaLabelledby}
  48. aria-label={ariaLabel}
  49. role={role}>
  50. <Tooltip
  51. mouseLeaveDelay={0.25}
  52. onShow={props.onShow}
  53. overlay={props.overlay}
  54. placement={props.placement}>
  55. <span className="display-inline-flex-center">
  56. {props.children || <HelpIcon fill={colors.gray60} size={size} />}
  57. </span>
  58. </Tooltip>
  59. </div>
  60. );
  61. }
  62. export function DarkHelpTooltip({ size = DEFAULT_SIZE, ...props }: Omit<Props, 'children'>) {
  63. return (
  64. <HelpTooltip {...props}>
  65. <HelpIcon fill={colors.transparentBlack} fillInner={colors.white} size={size} />
  66. </HelpTooltip>
  67. );
  68. }