aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/docs/DocTooltip.tsx
blob: d3f096a895750ad7dc85277a26ff213a9b987ae4 (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
/*
 * SonarQube
 * Copyright (C) 2009-2020 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 * as React from 'react';
import HelpTooltip from 'sonar-ui-common/components/controls/HelpTooltip';
import { lazyLoadComponent } from 'sonar-ui-common/components/lazyLoadComponent';
import { filterContent } from '../../helpers/markdown';

const DocMarkdownBlock = lazyLoadComponent(() => import('./DocMarkdownBlock'), 'DocMarkdownBlock');

interface Props {
  className?: string;
  children?: React.ReactNode;
  // Use as `import(/* webpackMode: "eager" */ 'Docs/tooltips/foo/bar.md')`
  doc: Promise<{ default: string }>;
  overlayProps?: T.Dict<string>;
}

interface State {
  content?: string;
}

export default class DocTooltip extends React.PureComponent<Props, State> {
  mounted = false;
  state: State = {};

  componentDidMount() {
    this.mounted = true;
    this.props.doc.then(
      ({ default: content }) => {
        if (this.mounted) {
          this.setState({ content });
        }
      },
      () => {}
    );
  }

  componentWillUnmount() {
    this.mounted = false;
  }

  render() {
    return this.state.content ? (
      <HelpTooltip
        className={this.props.className}
        overlay={
          <div className="abs-width-300">
            <DocMarkdownBlock
              childProps={this.props.overlayProps}
              className="cut-margins"
              content={filterContent(this.state.content)}
              isTooltip={true}
            />
          </div>
        }>
        {this.props.children}
      </HelpTooltip>
    ) : (
      this.props.children || null
    );
  }
}