Source code

Revision control

Copy as Markdown

Other Tools

{
"title": "Spotlight",
"description": "A template with an image, title, content and two buttons.",
"allOf": [
],
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"template": {
"type": "string",
"description": "Specify the layout template for the Spotlight",
"enum": ["logo-and-content", "multistage"]
},
"backdrop": {
"type": "string",
"description": "Background css behind modal content"
},
"logoImageURL": {
"type": "string",
"format": "uri",
"description": "(Deprecated by logo.imageURL)"
},
"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
},
"body": {
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"label": {
"description": "The title shown in the Spotlight message"
}
},
"required": ["label"]
},
"text": {
"type": "object",
"properties": {
"label": {
"description": "The content shown in the Spotlight message"
}
},
"required": ["label"]
},
"primary": {
"type": "object",
"properties": {
"label": {
"description": "The label for the primary button"
},
"action": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Action dispatched by the button."
},
"data": {
"type": "object"
}
},
"required": ["type"],
"additionalProperties": true
}
},
"required": ["label", "action"]
},
"secondary": {
"type": "object",
"properties": {
"label": {
"description": "The label for the secondary button"
}
},
"required": ["label", "action"]
}
},
"additionalProperties": true,
"required": ["title", "text", "primary", "secondary"]
},
"extra": {
"type": "object",
"properties": {
"expanded": {
"type": "object",
"properties": {
"label": {
"description": "The label for the secondary button"
}
},
"required": ["label"]
}
},
"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"
}
},
"additionalProperties": true,
"if": {
"properties": {
"logoImageURL": { "type": "null" }
}
},
"then": {
"properties": {
"logo": {
"oneOf": [
{
"required": ["imageURL"]
},
{
"required": ["imageId"]
}
]
}
}
},
"required": ["template"]
},
"template": {
"type": "string",
"const": "spotlight"
}
},
"additionalProperties": true,
"required": ["targeting"]
}