summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/content-src/asrouter/templates/CFR/templates/CFRUrlbarChiclet.schema.json
blob: ff5dff535ad39faf44355d8425431b486bcfb041 (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
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "file:///CFRUrlbarChiclet.schema.json",
  "title": "CFRUrlbarChiclet",
  "description": "A template with a chiclet button with text.",
  "allOf": [{ "$ref": "file:///FxMSCommon.schema.json#/$defs/Message" }],
  "type": "object",
  "properties": {
    "content": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "Attribute used for different groups of messages from the same provider"
        },
        "layout": {
          "type": "string",
          "description": "Describes how content should be displayed.",
          "enum": ["chiclet_open_url"]
        },
        "bucket_id": {
          "type": "string",
          "description": "A bucket identifier for the addon. This is used in order to anonymize telemetry for history-sensitive targeting."
        },
        "notification_text": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "The text in the small blue chicklet that appears in the URL bar. This can be a reference to a localized string in Firefox or just a plain string."
        },
        "active_color": {
          "type": "string",
          "description": "Background color of the button"
        },
        "action": {
          "type": "object",
          "properties": {
            "url": {
              "description": "The page to open when the button is clicked.",
              "type": "string",
              "format": "moz-url-format"
            },
            "where": {
              "description": "Should it open in a new tab or the current tab",
              "type": "string",
              "enum": ["current", "tabshifted"]
            }
          },
          "additionalProperties": true,
          "required": ["url", "where"]
        }
      },
      "additionalProperties": true,
      "required": [
        "layout",
        "category",
        "bucket_id",
        "notification_text",
        "action"
      ]
    },
    "template": {
      "type": "string",
      "const": "cfr_urlbar_chiclet"
    }
  },
  "required": ["targeting", "trigger"]
}