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
|
/*
* 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 { uniqBy } from 'lodash';
import * as React from 'react';
import { Helmet } from 'react-helmet-async';
import ScreenPositionHelper from '../../../components/common/ScreenPositionHelper';
import Suggestions from '../../../components/embed-docs-modal/Suggestions';
import { Location, withRouter } from '../../../components/hoc/withRouter';
import { translate } from '../../../helpers/l10n';
import { ExtendedSettingDefinition } from '../../../types/settings';
import { Component } from '../../../types/types';
import { CATEGORY_OVERRIDES } from '../constants';
import { getDefaultCategory } from '../utils';
import { ADDITIONAL_CATEGORIES } from './AdditionalCategories';
import AllCategoriesList from './AllCategoriesList';
import CategoryDefinitionsList from './CategoryDefinitionsList';
import PageHeader from './PageHeader';
export interface SettingsAppRendererProps {
definitions: ExtendedSettingDefinition[];
component?: Component;
loading: boolean;
location: Location;
}
export function SettingsAppRenderer(props: SettingsAppRendererProps) {
const { definitions, component, loading, location } = props;
const categories = React.useMemo(() => {
return uniqBy(
definitions.map((definition) => definition.category),
(category) => category.toLowerCase()
);
}, [definitions]);
if (loading) {
return null;
}
const { query } = location;
const defaultCategory = getDefaultCategory(categories);
const originalCategory = (query.category as string) || defaultCategory;
const overriddenCategory = CATEGORY_OVERRIDES[originalCategory.toLowerCase()];
const selectedCategory = overriddenCategory || originalCategory;
const foundAdditionalCategory = ADDITIONAL_CATEGORIES.find((c) => c.key === selectedCategory);
const isProjectSettings = component;
const shouldRenderAdditionalCategory =
foundAdditionalCategory &&
((isProjectSettings && foundAdditionalCategory.availableForProject) ||
(!isProjectSettings && foundAdditionalCategory.availableGlobally));
return (
<main id="settings-page">
<Suggestions suggestions="settings" />
<Helmet defer={false} title={translate('settings.page')} />
<PageHeader component={component} definitions={definitions} />
<div className="layout-page">
<ScreenPositionHelper className="layout-page-side-outer">
{({ top }) => (
<div className="layout-page-side" style={{ top }}>
<div className="layout-page-side-inner">
<AllCategoriesList
categories={categories}
component={component}
defaultCategory={defaultCategory}
selectedCategory={selectedCategory}
/>
</div>
</div>
)}
</ScreenPositionHelper>
<div className="layout-page-main">
<div className="layout-page-main-inner">
{/* Adding a key to force re-rendering of the category content, so that it resets the scroll position */}
<div className="big-padded" key={selectedCategory}>
{foundAdditionalCategory && shouldRenderAdditionalCategory ? (
foundAdditionalCategory.renderComponent({
categories,
component,
definitions,
selectedCategory: originalCategory,
})
) : (
<CategoryDefinitionsList
category={selectedCategory}
component={component}
definitions={definitions}
/>
)}
</div>
</div>
</div>
</div>
</main>
);
}
export default withRouter(SettingsAppRenderer);
|
