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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// @ts-check
/**
* @typedef {{}} Props - This is an empty object.
*/
/**
* @typedef {Object} State
* @property {boolean} isOnboardingEnabled
*/
/**
* @typedef {import("../../@types/perf").PanelWindow} PanelWindow
*/
"use strict";
const {
PureComponent,
createFactory,
} = require("resource://devtools/client/shared/vendor/react.js");
const {
b,
button,
div,
p,
} = require("resource://devtools/client/shared/vendor/react-dom-factories.js");
const Localized = createFactory(
require("resource://devtools/client/shared/vendor/fluent-react.js").Localized
);
const { openDocLink } = require("resource://devtools/client/shared/link.js");
const LEARN_MORE_URL = "https://profiler.firefox.com/docs";
const ONBOARDING_PREF = "devtools.performance.new-panel-onboarding";
/**
* This component provides a temporary onboarding message for users migrating
* from the old DevTools performance panel.
* @extends {React.PureComponent<Props>}
*/
class OnboardingMessage extends PureComponent {
/**
* @param {Props} props
*/
constructor(props) {
super(props);
// The preference has no default value for new profiles.
// If it is missing, default to true to show the message by default.
const isOnboardingEnabled = Services.prefs.getBoolPref(
ONBOARDING_PREF,
true
);
/** @type {State} */
this.state = { isOnboardingEnabled };
}
componentDidMount() {
Services.prefs.addObserver(ONBOARDING_PREF, this.onPreferenceUpdated);
}
componentWillUnmount() {
Services.prefs.removeObserver(ONBOARDING_PREF, this.onPreferenceUpdated);
}
handleCloseIconClick = () => {
Services.prefs.setBoolPref(ONBOARDING_PREF, false);
};
handleLearnMoreClick = () => {
openDocLink(LEARN_MORE_URL, {});
};
/**
* Update the state whenever the devtools.performance.new-panel-onboarding
* preference is updated.
*/
onPreferenceUpdated = () => {
const value = Services.prefs.getBoolPref(ONBOARDING_PREF, true);
this.setState({ isOnboardingEnabled: value });
};
render() {
const { isOnboardingEnabled } = this.state;
if (!isOnboardingEnabled) {
return null;
}
/** @type {any} */
const anyWindow = window;
// If gToolbox is not defined on window, the component is rendered in
// about:debugging, and no onboarding message should be displayed.
if (!anyWindow.gToolbox) {
return null;
}
const learnMoreLink = button({
className: "perf-external-link",
onClick: this.handleLearnMoreClick,
});
const closeButton = Localized(
{
id: "perftools-onboarding-close-button",
attrs: { "aria-label": true },
},
button({
className:
"perf-onboarding-close-button perf-photon-button perf-photon-button-ghost",
onClick: this.handleCloseIconClick,
})
);
return div(
{ className: "perf-onboarding" },
div(
{ className: "perf-onboarding-message" },
Localized(
{
id: "perftools-onboarding-message",
b: b(),
a: learnMoreLink,
},
p({ className: "perf-onboarding-message-row" })
)
),
closeButton
);
}
}
module.exports = OnboardingMessage;
|
