tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

Spotlight.schema.json (2621B)


      1 {
      2  "$schema": "https://json-schema.org/draft/2019-09/schema",
      3  "$id": "file:///Spotlight.schema.json",
      4  "title": "Spotlight",
      5  "description": "A template with an image, title, content and two buttons.",
      6  "allOf": [{ "$ref": "file:///FxMSCommon.schema.json#/$defs/Message" }],
      7  "type": "object",
      8  "properties": {
      9    "content": {
     10      "type": "object",
     11      "properties": {
     12        "template": {
     13          "type": "string",
     14          "description": "Specify the layout template for the Spotlight",
     15          "const": "multistage"
     16        },
     17        "backdrop": {
     18          "type": "string",
     19          "description": "Background css behind modal content"
     20        },
     21        "logo": {
     22          "type": "object",
     23          "properties": {
     24            "imageURL": {
     25              "type": "string",
     26              "description": "URL for image to use with the content"
     27            },
     28            "imageId": {
     29              "type": "string",
     30              "description": "The ID for a remotely hosted image"
     31            },
     32            "size": {
     33              "type": "string",
     34              "description": "The logo size."
     35            }
     36          },
     37          "additionalProperties": true
     38        },
     39        "screens": {
     40          "type": "array",
     41          "description": "Collection of individual screen content"
     42        },
     43        "transitions": {
     44          "type": "boolean",
     45          "description": "Show transitions within and between screens"
     46        },
     47        "disableEscClose": {
     48          "type": "boolean",
     49          "description": "Don't allow the message to be dismissed using the ESC key - for limited use in Spotlight modals only when the message content clearly informs the user that a decision is required to proceed"
     50        },
     51        "disableHistoryUpdates": {
     52          "type": "boolean",
     53          "description": "Don't alter the browser session's history stack - used with messaging surfaces like Feature Callouts"
     54        },
     55        "startScreen": {
     56          "type": "integer",
     57          "description": "Index of first screen to show from message, defaulting to 0"
     58        },
     59        "no-rdm": {
     60          "type": "boolean",
     61          "description": "If true, prevents the spotlight from entering responsive design mode at widths less than 800px"
     62        }
     63      },
     64      "additionalProperties": true
     65    },
     66    "template": {
     67      "type": "string",
     68      "description": "Specify whether the surface is shown as a Spotlight modal or an in-surface Feature Callout dialog",
     69      "enum": ["spotlight", "feature_callout"]
     70    }
     71  },
     72  "additionalProperties": true,
     73  "required": ["targeting"]
     74 }