summaryrefslogtreecommitdiffstats
path: root/browser/components/aboutwelcome/modules/AWToolbarUtils.sys.mjs
blob: b86bdf3ed2dd8f45d0aa9adb211fda2ac5aaad68 (plain)
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
/* 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/. */

import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";

const lazy = {};

ChromeUtils.defineESModuleGetters(lazy, {
  CustomizableUI: "resource:///modules/CustomizableUI.sys.mjs",
});

export const AWToolbarButton = {
  async maybeAddSetupButton() {
    // First check if we've already completed onboarding, in which
    // case we should remove the button.
    if (AWToolbarButton.didSeeFinalScreen) {
      AWToolbarButton.removeSetupButtonIfOnboardingComplete();
      return;
    }
    // Otherwise, check if this is a new profile where we need to add it.
    if (AWToolbarButton.hasToolbarButtonEnabled) {
      lazy.CustomizableUI.createWidget({
        id: "aboutwelcome-button",
        l10nId: "browser-aboutwelcome-button",
        defaultArea: lazy.CustomizableUI.AREA_BOOKMARKS,
        type: "button",
        onCreated(aNode) {
          aNode.className = "bookmark-item chromeclass-toolbar-additional";
        },
        onClick(aEvent) {
          AWToolbarButton.openWelcome(aEvent.view);
        },
      });
    }
  },

  removeSetupButtonIfOnboardingComplete() {
    //Look for completion of Onboarding (we're using an AWFinish()
    //call from about:welcome as a proxy here)
    if (
      AWToolbarButton.didSeeFinalScreen ||
      !AWToolbarButton.hasToolbarButtonEnabled
    ) {
      lazy.CustomizableUI.destroyWidget("aboutwelcome-button");
    }
  },

  openWelcome(win) {
    Services.prefs.setStringPref(
      "browser.aboutwelcome.entrypoint",
      "toolbarButton"
    );
    let viewURL = "about:welcome";
    win.gBrowser.addTrustedTab(viewURL, {
      inBackground: false,
    });
  },
};

XPCOMUtils.defineLazyPreferenceGetter(
  AWToolbarButton,
  "didSeeFinalScreen",
  "browser.aboutwelcome.didSeeFinalScreen",
  false,
  () => {
    AWToolbarButton.removeSetupButtonIfOnboardingComplete();
  }
);

XPCOMUtils.defineLazyPreferenceGetter(
  AWToolbarButton,
  "hasToolbarButtonEnabled",
  "browser.aboutwelcome.toolbarButtonEnabled",
  false,
  () => {
    AWToolbarButton.removeSetupButtonIfOnboardingComplete();
  }
);