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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* SonarQube
* Copyright (C) 2009-2023 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 { translate } from '../../helpers/l10n';
import { getBaseUrl } from '../../helpers/system';
import { SuggestionLink } from '../../types/types';
import DocLink from '../common/DocLink';
import Link from '../common/Link';
import { DropdownOverlay } from '../controls/Dropdown';
import { SuggestionsContext } from './SuggestionsContext';
interface Props {
onClose: () => void;
}
export default class EmbedDocsPopup extends React.PureComponent<Props> {
firstItem: HTMLAnchorElement | null = null;
/*
* Will be called by the first suggestion (if any), as well as the first link (documentation)
* Since we don't know if we have any suggestions, we need to allow both to make the call.
* If we have at least 1 suggestion, it will make the call first, and prevent 'documentation' from
* getting the focus.
*/
focusFirstItem: React.Ref<HTMLAnchorElement> = (node: HTMLAnchorElement | null) => {
if (node && !this.firstItem) {
this.firstItem = node;
this.firstItem.focus();
}
};
renderTitle(text: string, labelId: string) {
return (
<h2 className="menu-header" id={labelId}>
{text}
</h2>
);
}
renderSuggestions = ({ suggestions }: { suggestions: SuggestionLink[] }) => {
if (suggestions.length === 0) {
return null;
}
return (
<>
{this.renderTitle(translate('docs.suggestion'), 'suggestion')}
<ul className="menu abs-width-240" aria-labelledby="suggestion">
{suggestions.map((suggestion, i) => (
<li key={suggestion.link}>
<DocLink
innerRef={i === 0 ? this.focusFirstItem : undefined}
onClick={this.props.onClose}
to={suggestion.link}
>
{suggestion.text}
</DocLink>
</li>
))}
</ul>
</>
);
};
renderIconLink(link: string, icon: string, text: string) {
return (
<a href={link} rel="noopener noreferrer" target="_blank">
<img
alt={text}
aria-hidden={true}
className="spacer-right"
height="18"
src={`${getBaseUrl()}/images/${icon}`}
width="18"
/>
{text}
</a>
);
}
render() {
return (
<DropdownOverlay>
<SuggestionsContext.Consumer>{this.renderSuggestions}</SuggestionsContext.Consumer>
<ul className="menu abs-width-240">
<li>
<DocLink innerRef={this.focusFirstItem} onClick={this.props.onClose} to="/">
{translate('docs.documentation')}
</DocLink>
</li>
<li>
<Link onClick={this.props.onClose} to="/web_api">
{translate('api_documentation.page')}
</Link>
</li>
</ul>
<ul className="menu abs-width-240">
<li>
<Link
className="display-flex-center"
to="https://community.sonarsource.com/"
target="_blank"
>
{translate('docs.get_help')}
</Link>
</li>
</ul>
{this.renderTitle(translate('docs.stay_connected'), 'stay_connected')}
<ul className="menu abs-width-240" aria-labelledby="stay_connected">
<li>
{this.renderIconLink(
'https://www.sonarqube.org/whats-new/?referrer=sonarqube',
'embed-doc/sq-icon.svg',
translate('docs.news')
)}
</li>
<li>
{this.renderIconLink(
'https://www.sonarqube.org/roadmap/?referrer=sonarqube',
'embed-doc/sq-icon.svg',
translate('docs.roadmap')
)}
</li>
<li>
{this.renderIconLink(
'https://twitter.com/SonarQube',
'embed-doc/twitter-icon.svg',
'Twitter'
)}
</li>
</ul>
</DropdownOverlay>
);
}
}
|
