Source code
Revision control
Copy as Markdown
Other Tools
{
"title": "MenuMessage",
"description": "A template for messages that appear within our menus.",
"allOf": [
{
}
],
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"messageType": {
"type": "string",
"description": "The subtype of the message. 'fxa_cta' is used for Firefox Accounts messaging and is only visible when signed out, unless 'allowWhenSignedIn' property is provided. 'default_cta' is used for general messages, regardless of sign in state and only visible within the App Menu.",
"enum": ["fxa_cta", "default_cta"]
},
"primaryText": {
"description": "The primary text for the message, which offers the value proposition to the user."
},
"secondaryText": {
"description": "The second text for the message, which offers more detail on the value proposition to the user."
},
"closeAction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Action dispatched by the button."
},
"data": {
"type": "object"
}
},
"required": ["type"],
"additionalProperties": true,
"description": "The action to take upon clicking the close button."
},
"primaryAction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Action dispatched by the button."
},
"data": {
"type": "object"
}
},
"required": ["type"],
"additionalProperties": true,
"description": "The action to take upon clicking the primary action button."
},
"primaryActionText": {
"description": "The label for the primary action."
},
"primaryButtonSize": {
"type": "string",
"enum": ["default", "small"],
"description": "The size of the primary button, default is 'default'."
},
"imageURL": {
"type": "string",
"description": "URL for image to use with the content."
},
"imageWidth": {
"type": "number",
"description": "The image width in pixels. Default is 120px."
},
"logoURL": {
"type": "string",
"description": "URL for logo to use with the content."
},
"logoWidth": {
"type": "number",
"description": "The logo width in pixels. Default is 18px."
},
"imageVerticalTopOffset": {
"type": "number",
"description": "The margin-block-start value to apply to the image in pixels."
},
"imageVerticalBottomOffset": {
"type": "number",
"description": "The margin-block-end value to apply to the image in pixels, used in 'row' layouts."
},
"containerVerticalBottomOffset": {
"type": "number",
"description": "The container's margin-block-end value in pixels. Used to visually offset the image in 'row' layouts when 'imageVerticalBottomOffset' is applied."
},
"layout": {
"type": "string",
"description": "The layout of the message content and illustration. Row displays the image inline to the right of the text, column displays the image above the text. Simple layout only displays primary text and primary button on one row.",
"enum": ["row", "column", "simple"]
},
"allowWhenSignedIn": {
"type": "boolean",
"description": "If true, the message will be shown even when the user is signed in. For 'fxa_cta' messages. Defaults to false."
}
}
},
"template": {
"type": "string",
"const": "menu_message"
},
"testingTriggerContext": {
"type": "string",
"enum": ["app_menu", "pxi_menu"]
}
},
"additionalProperties": true
}