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
|
/*
* 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 classNames from 'classnames';
import * as React from 'react';
import { translate } from '../../helpers/l10n';
import './DeferredSpinner.css';
interface Props {
ariaLabel?: string;
children?: React.ReactNode;
className?: string;
customSpinner?: JSX.Element;
loading?: boolean;
timeout?: number;
}
interface State {
showSpinner: boolean;
}
const DEFAULT_TIMEOUT = 100;
/**
* Recommendation: do not render this component conditionally based on any loading state:
* // Don't do this:
* {loading && <DeferredSpinner />}
* Instead, pass the loading state as a prop:
* // Do this:
* <DeferredSpinner loading={loading} />
*/
export default class DeferredSpinner extends React.PureComponent<Props, State> {
timer?: number;
state: State = { showSpinner: false };
componentDidMount() {
if (this.props.loading == null || this.props.loading === true) {
this.startTimer();
}
}
componentDidUpdate(prevProps: Props) {
if (prevProps.loading === false && this.props.loading === true) {
this.stopTimer();
this.startTimer();
}
if (prevProps.loading === true && this.props.loading === false) {
this.stopTimer();
this.setState({ showSpinner: false });
}
}
componentWillUnmount() {
this.stopTimer();
}
startTimer = () => {
this.timer = window.setTimeout(
() => this.setState({ showSpinner: true }),
this.props.timeout || DEFAULT_TIMEOUT
);
};
stopTimer = () => {
window.clearTimeout(this.timer);
};
render() {
const { ariaLabel = translate('loading'), children, className, customSpinner } = this.props;
const { showSpinner } = this.state;
if (customSpinner) {
return showSpinner ? customSpinner : children;
}
return (
<>
<div className="sw-overflow-hidden">
<i
aria-live="polite"
data-testid="deferred-spinner"
className={classNames('deferred-spinner', className, {
'a11y-hidden': !showSpinner,
'is-loading': showSpinner,
})}
>
{showSpinner && <span className="a11y-hidden">{ariaLabel}</span>}
</i>
</div>
{!showSpinner && children}
</>
);
}
}
|
