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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/* 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/. */
"use strict";
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const DEVTOOLS_ENABLED_PREF = "devtools.enabled";
const MESSAGES = {
AboutDebugging: "about-debugging-message",
ContextMenu: "inspect-element-message",
HamburgerMenu: "menu-message",
KeyShortcut: "key-shortcut-message",
SystemMenu: "menu-message",
};
// Google analytics parameters that should be added to all outgoing links.
const GA_PARAMETERS = [
["utm_source", "devtools"],
["utm_medium", "onboarding"],
];
const KEY_SHORTCUTS_STRINGS =
"chrome://devtools-startup/locale/key-shortcuts.properties";
const keyShortcutsBundle = Services.strings.createBundle(KEY_SHORTCUTS_STRINGS);
// URL constructor doesn't support about: scheme,
// we have to use http in order to have working searchParams.
const url = new URL(window.location.href.replace("about:", "http://"));
const reason = url.searchParams.get("reason");
const tabid = parseInt(url.searchParams.get("tabid"), 10);
function getToolboxShortcut() {
const modifier = Services.appinfo.OS == "Darwin" ? "Cmd+Opt+" : "Ctrl+Shift+";
return (
modifier + keyShortcutsBundle.GetStringFromName("toggleToolbox.commandkey")
);
}
function onInstallButtonClick() {
Services.prefs.setBoolPref("devtools.enabled", true);
}
function onCloseButtonClick() {
window.close();
}
function updatePage() {
const installPage = document.getElementById("install-page");
const welcomePage = document.getElementById("welcome-page");
const isEnabled = Services.prefs.getBoolPref("devtools.enabled");
if (isEnabled) {
installPage.setAttribute("hidden", "true");
welcomePage.removeAttribute("hidden");
} else {
welcomePage.setAttribute("hidden", "true");
installPage.removeAttribute("hidden");
}
}
/**
* Array of descriptors for features displayed on about:devtools.
* Each feature should contain:
* - icon: the name of the image to use
* - title: the key of the localized title (from aboutDevTools.ftl)
* - desc: the key of the localized description (from aboutDevTools.ftl)
* - link: the MDN documentation link
*/
const features = [
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-inspector.svg",
title: "features-inspector-title",
desc: "features-inspector-desc",
link: "https://developer.mozilla.org/docs/Tools/Page_Inspector",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-console.svg",
title: "features-console-title",
desc: "features-console-desc",
link: "https://developer.mozilla.org/docs/Tools/Web_Console",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-debugger.svg",
title: "features-debugger-title",
desc: "features-debugger-desc",
link: "https://developer.mozilla.org/docs/Tools/Debugger",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-network.svg",
title: "features-network-title",
desc: "features-network-desc",
link: "https://developer.mozilla.org/docs/Tools/Network_Monitor",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-storage.svg",
title: "features-storage-title",
desc: "features-storage-desc",
link: "https://developer.mozilla.org/docs/Tools/Storage_Inspector",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-responsive.svg",
title: "features-responsive-title",
desc: "features-responsive-desc",
link: "https://developer.mozilla.org/docs/Tools/Responsive_Design_Mode",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-visualediting.svg",
title: "features-visual-editing-title",
desc: "features-visual-editing-desc",
link: "https://developer.mozilla.org/docs/Tools/Style_Editor",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-performance.svg",
title: "features-performance-title",
desc: "features-performance-desc",
link: "https://developer.mozilla.org/docs/Tools/Performance",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-memory.svg",
title: "features-memory-title",
desc: "features-memory-desc",
link: "https://developer.mozilla.org/docs/Tools/Memory",
},
];
/**
* Helper to create a DOM element to represent a DevTools feature.
*/
function createFeatureEl(feature) {
const li = document.createElement("li");
li.classList.add("feature");
const { icon, link, title, desc } = feature;
// eslint-disable-next-line no-unsanitized/property
li.innerHTML = `
<h3 class="feature-name">
<a class="feature-link" href="${link}" target="_blank">
<img class="feature-icon" src="${icon}" alt="" />
<span data-l10n-id="${title}"></span>
</a>
</h3>
<p class="feature-desc" data-l10n-id="${desc}">
<a class="feature-more-link external" href="${link}"
aria-hidden="true" tabindex="-1"
target="_blank" data-l10n-name="learn-more"></a>
</p>`;
return li;
}
window.addEventListener(
"load",
function() {
const inspectorShortcut = getToolboxShortcut();
const welcomeMessage = document.getElementById("welcome-message");
// Set the welcome message content with the correct keyboard shortcut for the current
// platform.
document.l10n.setAttributes(welcomeMessage, "welcome-message", {
shortcut: inspectorShortcut,
});
// Set the appropriate title message.
if (reason == "ContextMenu") {
document.getElementById("inspect-title").removeAttribute("hidden");
} else {
document.getElementById("common-title").removeAttribute("hidden");
}
// Display the message specific to the reason
const id = MESSAGES[reason];
if (id) {
const message = document.getElementById(id);
message.removeAttribute("hidden");
}
// Attach event listeners
document
.getElementById("install")
.addEventListener("click", onInstallButtonClick);
document
.getElementById("close")
.addEventListener("click", onCloseButtonClick);
Services.prefs.addObserver(DEVTOOLS_ENABLED_PREF, updatePage);
const featuresContainer = document.querySelector(".features-list");
for (const feature of features) {
featuresContainer.appendChild(createFeatureEl(feature));
}
// Add Google Analytics parameters to all the external links.
const externalLinks = document.querySelectorAll("a[href*='mozilla.org']");
for (const link of externalLinks) {
const linkUrl = new URL(link.getAttribute("href"));
GA_PARAMETERS.forEach(([key, value]) =>
linkUrl.searchParams.set(key, value)
);
link.setAttribute("href", linkUrl.href);
}
// Update the current page based on the current value of DEVTOOLS_ENABLED_PREF.
updatePage();
},
{ once: true }
);
window.addEventListener(
"beforeunload",
function() {
// Focus the tab that triggered the DevTools onboarding.
if (document.visibilityState != "visible") {
// Only try to focus the correct tab if the current tab is the about:devtools page.
return;
}
// Retrieve the original tab if it is still available.
const browserWindow = Services.wm.getMostRecentWindow("navigator:browser");
const { gBrowser } = browserWindow;
const originalBrowser = gBrowser.getBrowserForOuterWindowID(tabid);
const originalTab = gBrowser.getTabForBrowser(originalBrowser);
if (originalTab) {
// If the original tab was found, select it.
gBrowser.selectedTab = originalTab;
}
},
{ once: true }
);
window.addEventListener(
"unload",
function() {
document
.getElementById("install")
.removeEventListener("click", onInstallButtonClick);
document
.getElementById("close")
.removeEventListener("click", onCloseButtonClick);
Services.prefs.removeObserver(DEVTOOLS_ENABLED_PREF, updatePage);
},
{ once: true }
);
|
