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
|
/*
* 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 { ThemeProvider } from '@emotion/react';
import styled from '@emotion/styled';
import { lightTheme, themeColor, ToastMessageContainer } from 'design-system';
import * as React from 'react';
import { Outlet, useLocation } from 'react-router-dom';
import A11yProvider from '../../components/a11y/A11yProvider';
import A11ySkipLinks from '../../components/a11y/A11ySkipLinks';
import SuggestionsProvider from '../../components/embed-docs-modal/SuggestionsProvider';
import NCDAutoUpdateMessage from '../../components/new-code-definition/NCDAutoUpdateMessage';
import Workspace from '../../components/workspace/Workspace';
import GlobalFooter from './GlobalFooter';
import IndexationContextProvider from './indexation/IndexationContextProvider';
import IndexationNotification from './indexation/IndexationNotification';
import LanguagesContextProvider from './languages/LanguagesContextProvider';
import MetricsContextProvider from './metrics/MetricsContextProvider';
import GlobalNav from './nav/global/GlobalNav';
import PromotionNotification from './promotion-notification/PromotionNotification';
import StartupModal from './StartupModal';
import SystemAnnouncement from './SystemAnnouncement';
import UpdateNotification from './update-notification/UpdateNotification';
/*
* These pages need a white background (aka 'secondary', rather than the default 'primary')
* This should be revisited at some point (why the exception?)
*/
const PAGES_WITH_SECONDARY_BACKGROUND = [
'/tutorials',
'/projects/create',
'/project/baseline',
'/project/branches',
'/project/key',
'/project/deletion',
'/project/links',
'/project/import_export',
'/project/quality_gate',
'/project/quality_profiles',
'/project/webhooks',
'/admin/webhooks',
'/project_roles',
'/admin/permissions',
'/admin/permission_templates',
'/project/background_tasks',
'/admin/background_tasks',
'/admin/groups',
'/admin/marketplace',
'/admin/system',
'/admin/users',
'/admin/settings',
'/admin/settings/encryption',
'/admin/extension/license/support',
'/admin/audit',
'/admin/projects_management',
'/account/projects',
];
export default function GlobalContainer() {
// it is important to pass `location` down to `GlobalNav` to trigger render on url change
const location = useLocation();
return (
<ThemeProvider theme={lightTheme}>
<SuggestionsProvider>
<A11yProvider>
<A11ySkipLinks />
<div className="global-container">
<GlobalBackground
secondary={PAGES_WITH_SECONDARY_BACKGROUND.includes(location.pathname)}
className="sw-box-border sw-flex-[1_0_auto]"
id="container"
>
<div className="page-container">
<Workspace>
<ToastMessageContainer />
<IndexationContextProvider>
<LanguagesContextProvider>
<MetricsContextProvider>
<div className="sw-sticky sw-top-0 sw-z-global-navbar">
<SystemAnnouncement />
<IndexationNotification />
<NCDAutoUpdateMessage />
<UpdateNotification dismissable />
<GlobalNav location={location} />
{/* The following is the portal anchor point for the component nav
* See ComponentContainer.tsx
*/}
<div id="component-nav-portal" />
</div>
<Outlet />
</MetricsContextProvider>
</LanguagesContextProvider>
</IndexationContextProvider>
</Workspace>
</div>
<PromotionNotification />
</GlobalBackground>
<GlobalFooter />
</div>
<StartupModal />
</A11yProvider>
</SuggestionsProvider>
</ThemeProvider>
);
}
const GlobalBackground = styled.div<{ secondary: boolean }>`
background-color: ${({ secondary }) =>
themeColor(secondary ? 'backgroundSecondary' : 'backgroundPrimary')};
`;
|
