Source code
Revision control
Copy as Markdown
Other Tools
{
"title": "Spotlight",
"description": "A template with an image, title, content and two buttons.",
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"template": {
"type": "string",
"description": "Specify the layout template for the Spotlight",
"const": "multistage"
},
"backdrop": {
"type": "string",
"description": "Background css behind modal content"
},
"logo": {
"type": "object",
"properties": {
"imageURL": {
"type": "string",
"description": "URL for image to use with the content"
},
"imageId": {
"type": "string",
"description": "The ID for a remotely hosted image"
},
"size": {
"type": "string",
"description": "The logo size."
}
},
"additionalProperties": true
},
"screens": {
"type": "array",
"description": "Collection of individual screen content"
},
"transitions": {
"type": "boolean",
"description": "Show transitions within and between screens"
},
"disableHistoryUpdates": {
"type": "boolean",
"description": "Don't alter the browser session's history stack - used with messaging surfaces like Feature Callouts"
},
"startScreen": {
"type": "integer",
"description": "Index of first screen to show from message, defaulting to 0"
},
"no-rdm": {
"type": "boolean",
"description": "If true, prevents the spotlight from entering responsive design mode at widths less than 800px"
}
},
"additionalProperties": true
},
"template": {
"type": "string",
"description": "Specify whether the surface is shown as a Spotlight modal or an in-surface Feature Callout dialog",
"enum": ["spotlight", "feature_callout"]
}
},
"additionalProperties": true,
"required": ["targeting"]
}