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
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_VIEWS_USER_EDUCATION_CUSTOM_WEBUI_HELP_BUBBLE_CONTROLLER_H_
#define CHROME_BROWSER_UI_VIEWS_USER_EDUCATION_CUSTOM_WEBUI_HELP_BUBBLE_CONTROLLER_H_
#include <concepts>
#include <memory>
#include <string>
#include "chrome/browser/ui/webui/top_chrome/top_chrome_webui_config.h"
#include "components/user_education/common/help_bubble/custom_help_bubble.h"
#include "content/public/browser/web_ui_controller.h"
#include "content/public/common/url_constants.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "ui/color/color_id.h"
#include "ui/webui/resources/cr_components/help_bubble/custom_help_bubble.mojom.h"
// Derive your WebUIController from this if you want it to be used as a Custom
// Help Bubble UI. This will handle proxying all help-bubble-specific events
// from the bubble to the User Education system.
class CustomWebUIHelpBubbleController
: public custom_help_bubble::mojom::CustomHelpBubbleHandlerFactory,
public user_education::CustomHelpBubbleUi {
public:
CustomWebUIHelpBubbleController();
~CustomWebUIHelpBubbleController() override;
// Instantiates the implementor of the
// help_bubble::mojom::CustomHelpBubbleHandler mojo interface passing the
// pending receiver that will be internally bound.
void BindInterface(mojo::PendingReceiver<
custom_help_bubble::mojom::CustomHelpBubbleHandlerFactory>
pending_receiver);
// Gets the background, frame, and arrow color for the bubble. Defaults to the
// normal help bubble background color.
virtual ui::ColorId GetBackgroundAndFrameColor() const;
// This is required for wrapping help bubbles for Top Chrome.
static constexpr std::string_view GetWebUIName() { return "UserEducation"; }
private:
class CustomHelpBubbleHandler;
// custom_help_bubble::mojom::CustomHelpBubbleHandlerFactory:
void CreateCustomHelpBubbleHandler(
mojo::PendingReceiver<custom_help_bubble::mojom::CustomHelpBubbleHandler>
handler) override;
std::unique_ptr<CustomHelpBubbleHandler> custom_help_bubble_handler_;
mojo::Receiver<custom_help_bubble::mojom::CustomHelpBubbleHandlerFactory>
custom_help_bubble_handler_factory_receiver_{this};
};
// You need to do this in your custom help bubble WebUI controller `.h` file,
// and then register it in `chrome_web_ui_configs.cc`.
#define DECLARE_TOP_CHROME_WEBUI_CONFIG(ControllerClass, HostName) \
class ControllerClass##Config \
: public DefaultTopChromeWebUIConfig<ControllerClass> { \
public: \
ControllerClass##Config() \
: DefaultTopChromeWebUIConfig(content::kChromeUIScheme, HostName) {} \
~ControllerClass##Config() override = default; \
bool ShouldAutoResizeHost() override; \
}
// You need to do this in your custom help bubble WebUI controller `.cc` file.
#define DEFINE_TOP_CHROME_WEBUI_CONFIG(ControllerClass) \
bool ControllerClass##Config::ShouldAutoResizeHost() { \
return true; \
}
// In order to be considered a controller for a custom help bubble WebUI, a
// class must be both a WebUI controller and a Custom WebUI Help Bubble.
template <typename T>
concept IsCustomWebUIHelpBubbleController =
std::derived_from<T, CustomWebUIHelpBubbleController> &&
std::derived_from<T, content::WebUIController>;
#endif // CHROME_BROWSER_UI_VIEWS_USER_EDUCATION_CUSTOM_WEBUI_HELP_BUBBLE_CONTROLLER_H_
|
