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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
---
breadcrumbs:
- - /developers
- For Developers
page_name: webui
title: Creating Chrome WebUI Interfaces
---
If you are building a WebUI interface under components/ then see [Creating WebUI
Interfaces in
components/](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/webui_in_components.md)
Creating a Chrome WebUI interface is simple yet involves changing a number of
files. This guide briefly steps over the process. For brevity, copyright notices
are not placed at the beginning of the new files but in practice do not forget
to add these.
### Creating the WebUI page
WebUI resources are located in the resources folder,
`src/chrome/browser/resources`. When creating WebUI resources, follow the [Web
Development Style Guide](/developers/web-development-style-guide). For a sample
WebUI page you could start with the following files:
src/chrome/browser/resources/hello_world.html:
```none
<!DOCTYPE HTML>
<html i18n-values="dir:textdirection">
<head>
<meta charset="utf-8">
<title i18n-content="helloWorldTitle"></title>
<link rel="stylesheet" href="hello_world.css">
<script src="chrome://resources/js/cr.js"></script>
<script src="chrome://resources/js/load_time_data.js"></script>
<script src="chrome://resources/js/util.js"></script>
<script src="strings.js"></script>
<script src="hello_world.js"></script>
</head>
<body i18n-values=".style.fontFamily:fontfamily;.style.fontSize:fontsize">
<h1 i18n-content="helloWorldTitle"></h1>
<p id="welcome-message"></p>
<script src="chrome://resources/js/i18n_template.js"></script>
</body>
</html>
```
src/chrome/browser/resources/hello_world.css:
```none
p {
white-space: pre-wrap;
}
```
src/chrome/browser/resources/hello_world.js:
```none
cr.define('hello_world', function() {
'use strict';
/**
* Be polite and insert translated hello world strings for the user on loading.
*/
function initialize() {
$('welcome-message').textContent = loadTimeData.getStringF('welcomeMessage',
loadTimeData.getString('userName'));
}
// Return an object with all of the exports.
return {
initialize: initialize,
};
});
document.addEventListener('DOMContentLoaded', hello_world.initialize);
```
### Adding the resources to Chrome
Resources files are added to Chrome using the
`src/chrome/browser/browser_resources.grd` file. The following additions add our
hello_world files:
src/chrome/browser/browser_resources.grd:
```none
+ <include name="IDR_HELLO_WORLD_HTML" file="resources\hello_world.html" type="BINDATA" />
+ <include name="IDR_HELLO_WORLD_CSS" file="resources\hello_world.css" type="BINDATA" />
+ <include name="IDR_HELLO_WORLD_JS" file="resources\hello_world.js" type="BINDATA" />
```
Adding URL constants for new chrome URL
URL constants are stored in the files `src/chrome/common/webui_url_constants.*`.
This is where you will add the URL or URL's which will be directed to your new
resources.
src/chrome/common/webui_url_constants.h:
```none
+ extern const char kChromeUIHelloWorldURL[];
...
+ extern const char kChromeUIHelloWorldHost[];
```
src/chrome/common/webui_url_constants.cc:
```none
+ const char kChromeUIHelloWorldURL[] = "chrome://hello-world/";
...
+ const char kChromeUIHelloWorldHost[] = "hello-world";
```
Adding localized strings
We need a few string resources for translated strings to work on the new
resource. The welcome message contains a variable with a sample value so that it
can be accurately translated.
src/chrome/app/generated_resources.grd:
```none
+ <message name="IDS_HELLO_WORLD_TITLE" desc="A happy message saying hello to the world">
+ Hello World!
+ </message>
+ <message name="IDS_HELLO_WORLD_WELCOME_TEXT" desc="Message welcoming the user to the hello world page">
+ Welcome to this fancy Hello World page <ph name="WELCOME_NAME">$1<ex>Chromium User</ex></ph>!
+ </message>
```
Adding a WebUI class for handling requests to the chrome://hello-world/ URL
Next we need a class to handle requests to this new resource URL. Typically this
will subclass ChromeWebUI (but WebUI dialogs should subclass HtmlDialogUI
instead).
src/chrome/browser/ui/webui/hello_world_ui.h:
```none
#ifndef CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_UI_H_
#define CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_UI_H_
#pragma once
#include "base/macros.h"
#include "content/public/browser/web_ui_controller.h"
// The WebUI for chrome://hello-world
class HelloWorldUI : public content::WebUIController {
public:
explicit HelloWorldUI(content::WebUI* web_ui);
~HelloWorldUI() override;
private:
DISALLOW_COPY_AND_ASSIGN(HelloWorldUI);
};
#endif // CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_UI_H_
```
src/chrome/browser/ui/webui/hello_world_ui.cc:
```none
#include "chrome/browser/ui/webui/hello_world_ui.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/common/url_constants.h"
#include "chrome/grit/browser_resources.h"
#include "chrome/grit/generated_resources.h"
#include "content/public/browser/web_ui_data_source.h"
HelloWorldUI::HelloWorldUI(content::WebUI* web_ui)
: content::WebUIController(web_ui) {
// Set up the chrome://hello-world source.
content::WebUIDataSource* html_source =
content::WebUIDataSource::Create(chrome::kChromeUIHelloWorldHost);
// Localized strings.
html_source->AddLocalizedString("helloWorldTitle", IDS_HELLO_WORLD_TITLE);
html_source->AddLocalizedString("welcomeMessage", IDS_HELLO_WORLD_WELCOME_TEXT);
// As a demonstration of passing a variable for JS to use we pass in the name "Bob".
html_source->AddString("userName", "Bob");
html_source->UseStringsJs();
// Add required resources.
html_source->AddResourcePath("hello_world.css", IDR_HELLO_WORLD_CSS);
html_source->AddResourcePath("hello_world.js", IDR_HELLO_WORLD_JS);
html_source->SetDefaultResource(IDR_HELLO_WORLD_HTML);
Profile* profile = Profile::FromWebUI(web_ui);
content::WebUIDataSource::Add(profile, html_source);
}
HelloWorldUI::~HelloWorldUI() {
}
```
Adding new sources to Chrome
In order for your new class to be built and linked in it needs to be added to
the project gypi file.
src/chrome/browser/ui/BUILD.gn:
```none
sources = [
...
+ "webui/hello_world_ui.cc",
+ "webui/hello_world_ui.h",
```
Adding your WebUI request handler to the Chrome WebUI factory
The Chrome WebUI factory is where you setup your new request handler.
src/chrome/browser/ui/webui/chrome_web_ui_controller_factory.cc:
```none
+ #include "chrome/browser/ui/webui/hello_world_ui.h"
...
+ if (url.host() == chrome::kChromeUIHelloWorldHost)
+ return &NewWebUI<HelloWorldUI>;
```
Testing
You're done! Assuming no errors (because everyone gets their code perfect the
first time) you should be able to compile and run chrome and navigate to
chrome://hello-world/ and see your nifty welcome text!
### Adding a callback handler
You probably want your new WebUI page to be able to do something or get
information from the C++ world. For this, we use message callback handlers.
Let's say that we don't trust the Javascript engine to be able to add two
integers together (since we know that it uses floating point values internally).
We could add a callback handler to perform integer arithmetic for us.
src/chrome/browser/ui/webui/hello_world_ui.h:
```none
#include "chrome/browser/ui/webui/chrome_web_ui.h"
+
+ namespace base {
+ class ListValue;
+ } // namespace base
// The WebUI for chrome://hello-world
...
// Set up the chrome://hello-world source.
ChromeWebUIDataSource* html_source =
new ChromeWebUIDataSource(chrome::kChromeUIHelloWorldHost);
+
+ // Register callback handler.
+ RegisterMessageCallback("addNumbers",
+ base::Bind(&HelloWorldUI::AddNumbers,
+ base::Unretained(this)));
// Localized strings.
...
virtual ~HelloWorldUI();
+
+ private:
+ // Add two numbers together using integer arithmetic.
+ void AddNumbers(const base::ListValue* args);
DISALLOW_COPY_AND_ASSIGN(HelloWorldUI);
};
```
src/chrome/browser/ui/webui/hello_world_ui.cc:
```none
#include "chrome/browser/ui/webui/hello_world_ui.h"
+
+ #include "base/values.h"
#include "chrome/browser/profiles/profile.h"
...
HelloWorldUI::~HelloWorldUI() {
}
+
+ void HelloWorldUI::AddNumbers(const base::ListValue* args) {
+ int term1, term2;
+ if (!args->GetInteger(0, &term1) || !args->GetInteger(1, &term2))
+ return;
+ base::FundamentalValue result(term1 + term2);
+ CallJavascriptFunction("hello_world.addResult", result);
+ }
```
src/chrome/browser/resources/hello_world.js:
```none
function initialize() {
+ chrome.send('addNumbers', [2, 2]);
}
+
+ function addResult(result) {
+ alert('The result of our C++ arithmetic: 2 + 2 = ' + result);
+ }
return {
+ addResult: addResult,
initialize: initialize,
};
```
You'll notice that the call is asynchronous. We must wait for the C++ side to
call our Javascript function to get the result.
## Creating a WebUI Dialog
Once you've created a WebUI resource following the above instructions, there are
two changes necessary to make it a dialog. You must subclass the HtmlDialogUI
class instead of ChromeWebUI and create an HtmlDialogUIDelegate class which will
be responsible for running the dialog.
1. Instead of subclassing the ChromeWebUI class as above you will need an
instance of HtmlDialogUI.
src/chrome/browser/ui/webui/hello_world_ui.h:
```none
- #include "#chrome/browser/ui/webui/chrome_web_ui.h"
+ #include "#chrome/browser/ui/webui/html_dialog_ui.h"
- class HelloWorldUI : public ChromeWebUI {
+ class HelloWorldUI : public HtmlDialogUI {
```
2. Create an HtmlDialogUIDelegate class which is used to instantiate the dialog.
For brevity each of these functions are stubbed out with the minimal code
possible.
src/chrome/browser/ui/webui/hello_world.h
```none
#ifndef CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_H_
#define CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_H_
#pragma once
#include "chrome/browser/ui/webui/html_dialog_ui.h"
class HelloWorldDialog : private HtmlDialogUIDelegate {
public:
// Shows the Hello World dialog.
static void ShowDialog();
virtual ~HelloWorldDialog();
private:
// Construct a Hello World dialog
explicit HelloWorldDialog();
// Overridden from HtmlDialogUI::Delegate:
virtual bool IsDialogModal() const OVERRIDE;
virtual string16 GetDialogTitle() const OVERRIDE;
virtual GURL GetDialogContentURL() const OVERRIDE;
virtual void GetWebUIMessageHandlers(
std::vector<WebUIMessageHandler*>* handlers) const OVERRIDE;
virtual void GetDialogSize(gfx::Size* size) const OVERRIDE;
virtual std::string GetDialogArgs() const OVERRIDE;
virtual void OnDialogClosed(const std::string& json_retval) OVERRIDE;
virtual void OnCloseContents(
TabContents* source, bool* out_close_dialog) OVERRIDE;
virtual bool ShouldShowDialogTitle() const OVERRIDE;
DISALLOW_COPY_AND_ASSIGN(HelloWorldDialog);
};
#endif // CHROME_BROWSER_UI_WEBUI_HELLO_WORLD_H_
```
src/chrome/browser/ui/webui/hello_world.cc
```none
#include "base/utf_string_conversions.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/webui/hello_world.h"
#include "chrome/common/url_constants.h"
void HelloWorldDialog::ShowDialog() {
Browser* browser = BrowserList::GetLastActive();
DCHECK(browser);
browser->BrowserShowHtmlDialog(new HelloWorldDialog(), NULL);
}
HelloWorldDialog::HelloWorldDialog() {
}
HelloWorldDialog::~HelloWorldDialog() {
}
bool HelloWorldDialog::IsDialogModal() {
return false;
}
string16 HelloWorldDialog::GetDialogTitle() {
return UTF8ToUTF16("Hello World");
}
GURL HelloWorldDialog::GetDialogContentURL() const {
return GURL(chrome::kChromeUIHelloWorldURL);
}
void HelloWorldDialog::GetWebUIMessageHandlers(
std::vector<WebUIMessageHandler*>* handlers) const {
}
void HelloWorldDialog::GetDialogSize(gfx::Size* size) const {
size->SetSize(600, 400);
}
std::string HelloWorldDialog::GetDialogArgs() const {
return std::string();
}
void HelloWorldDialog::OnDialogClosed(const std::string& json_retval) {
delete this;
}
void HelloWorldDialog::OnCloseContents(TabContents* source,
bool* out_close_dialog) {
if (out_close_dialog)
*out_close_dialog = true;
}
bool HelloWorldDialog::ShouldShowDialogTitle() const {
return true;
}
```
You can invoke this new dialog by calling HelloWorldDialog::ShowDialog().
### Passing arguments to the WebUI
As you may have guessed, the HtmlDialogUIDelegate::GetDialogArgs() function call
is used for passing arguments to a dialog page. For example, if we wanted to
have a custom message displayed to the user depending on some argument known
only at dialog creation we could pass that argument in during construction,
return it from GetDialogArgs, and access it in Javascript from
chrome.dialogArguments as follows:
src/chrome/browser/ui/webui/hello_world.h
```none
- static void ShowDialog();
+ static void ShowDialog(std::string message);
+ // The message to be displayed to the user.
+ std::string message_;
+
DISALLOW_COPY_AND_ASSIGN(HelloWorldDialog);
};
```
src/chrome/browser/ui/webui/hello_world.cc
```none
- HelloWorldDialog::HelloWorldDialog() {
+ HelloWorldDialog::HelloWorldDialog(std::string message)
+ : message_(message) {
}
std::string HelloWorldDialog::GetDialogArgs() const {
- return std::string();
+ return message_;
}
```
src/chrome/browser/resources/hello_world.js:
```none
function initialize() {
+ document.getElementsByTagName('p')[0].textContent = chrome.dialogArguments;
}
```
In practice you will probably be passing structured data to your WebUI for which
you can use the class base::JSONWriter to produce a JSON string which can be
parsed in javascript using JSON.parse(chrome.dialogArguments). TODO: Provide
example of this.
### Adding dialog callback handlers
Sometimes there are resources or objects that you have available at the time of
dialog creation which will not be available from the context of the HtmlDialogUI
class. You can add callbacks to your HtmlDialogUIDelegate class which Javascript
can then call directly. This is done from the overridden
HtmlDialogUIDelegate::GetWebUIMessageHandlers. The actual handlers are then
written the same as for regular WebUI. TODO: Provide example.
|
